apollo::cyber::message::MessageHeader类 参考

#include <message_header.h>

apollo::cyber::message::MessageHeader 的协作图:

Public 成员函数
	MessageHeader ()
bool	is_magic_num_match (const char *other, size_t other_len) const
void	reset_magic_num ()
uint64_t	seq () const
void	set_seq (uint64_t seq)
void	reset_seq ()
uint64_t	timestamp_ns () const
void	set_timestamp_ns (uint64_t timestamp_ns)
void	reset_timestamp_ns ()
uint64_t	src_id () const
void	set_src_id (uint64_t src_id)
void	reset_src_id ()
uint64_t	dst_id () const
void	set_dst_id (uint64_t dst_id)
void	reset_dst_id ()
const char *	msg_type () const
void	set_msg_type (const char *msg_type, size_t msg_type_len)
void	reset_msg_type ()
void	reset_res ()
uint32_t	content_size () const
void	set_content_size (uint32_t content_size)
void	reset_content_size ()

详细描述

在文件 message_header.h 第 31 行定义.

构造及析构函数说明

MessageHeader()

apollo::cyber::message::MessageHeader::MessageHeader ( )

inline

在文件 message_header.h 第 33 行定义.

                  {
    reset_magic_num();
    reset_seq();
    reset_timestamp_ns();
    reset_src_id();
    reset_dst_id();
    reset_msg_type();
    reset_res();
    reset_content_size();
  }

成员函数说明

content_size()

uint32_t apollo::cyber::message::MessageHeader::content_size ( ) const

inline

在文件 message_header.h 第 90 行定义.

{ return ConvertArrayTo32(content_size_); }

dst_id()

uint64_t apollo::cyber::message::MessageHeader::dst_id ( ) const

inline

在文件 message_header.h 第 68 行定义.

{ return ConvertArrayTo64(dst_id_); }

is_magic_num_match()

bool apollo::cyber::message::MessageHeader::is_magic_num_match ( const char *  other, size_t  other_len  ) const

inline

在文件 message_header.h 第 44 行定义.

                                                                     {
    if (other == nullptr || other_len != sizeof(magic_num_)) {
      return false;
    }
    return memcmp(magic_num_, other, sizeof(magic_num_)) == 0;
  }

msg_type()

const char * apollo::cyber::message::MessageHeader::msg_type ( ) const

inline

在文件 message_header.h 第 74 行定义.

{ return msg_type_; }

reset_content_size()

void apollo::cyber::message::MessageHeader::reset_content_size ( )

inline

在文件 message_header.h 第 94 行定义.

{ memset(content_size_, 0, sizeof(content_size_)); }

reset_dst_id()

void apollo::cyber::message::MessageHeader::reset_dst_id ( )

inline

在文件 message_header.h 第 72 行定义.

{ memset(dst_id_, 0, sizeof(dst_id_)); }

reset_magic_num()

void apollo::cyber::message::MessageHeader::reset_magic_num ( )

inline

在文件 message_header.h 第 50 行定义.

{ memcpy(magic_num_, "BDACBDAC", sizeof(magic_num_)); }

reset_msg_type()

void apollo::cyber::message::MessageHeader::reset_msg_type ( )

inline

在文件 message_header.h 第 86 行定义.

{ memset(msg_type_, 0, sizeof(msg_type_)); }

reset_res()

void apollo::cyber::message::MessageHeader::reset_res ( )

inline

在文件 message_header.h 第 88 行定义.

{ memset(res_, 0, sizeof(res_)); }

reset_seq()

void apollo::cyber::message::MessageHeader::reset_seq ( )

inline

在文件 message_header.h 第 54 行定义.

{ memset(seq_, 0, sizeof(seq_)); }

reset_src_id()

void apollo::cyber::message::MessageHeader::reset_src_id ( )

inline

在文件 message_header.h 第 66 行定义.

{ memset(src_id_, 0, sizeof(src_id_)); }

reset_timestamp_ns()

void apollo::cyber::message::MessageHeader::reset_timestamp_ns ( )

inline

在文件 message_header.h 第 60 行定义.

{ memset(timestamp_ns_, 0, sizeof(timestamp_ns_)); }

seq()

uint64_t apollo::cyber::message::MessageHeader::seq ( ) const

inline

在文件 message_header.h 第 52 行定义.

{ return ConvertArrayTo64(seq_); }

set_content_size()

void apollo::cyber::message::MessageHeader::set_content_size ( uint32_t  content_size )

inline

在文件 message_header.h 第 91 行定义.

                                               {
    Convert32ToArray(content_size, const_cast<char*>(content_size_));
  }

set_dst_id()

void apollo::cyber::message::MessageHeader::set_dst_id ( uint64_t  dst_id )

inline

在文件 message_header.h 第 69 行定义.

                                   {
    Convert64ToArray(dst_id, const_cast<char*>(dst_id_));
  }

set_msg_type()

void apollo::cyber::message::MessageHeader::set_msg_type ( const char *  msg_type, size_t  msg_type_len  )

inline

在文件 message_header.h 第 75 行定义.

                                                               {
    if (msg_type == nullptr || msg_type_len == 0) {
      return;
    }
    size_t real_len = msg_type_len;
    if (msg_type_len >= sizeof(msg_type_)) {
      real_len = sizeof(msg_type_) - 1;
    }
    reset_msg_type();
    memcpy(msg_type_, msg_type, real_len);
  }

set_seq()

void apollo::cyber::message::MessageHeader::set_seq ( uint64_t  seq )

inline

在文件 message_header.h 第 53 行定义.

{ Convert64ToArray(seq, const_cast<char*>(seq_)); }

set_src_id()

void apollo::cyber::message::MessageHeader::set_src_id ( uint64_t  src_id )

inline

在文件 message_header.h 第 63 行定义.

                                   {
    Convert64ToArray(src_id, const_cast<char*>(src_id_));
  }

set_timestamp_ns()

void apollo::cyber::message::MessageHeader::set_timestamp_ns ( uint64_t  timestamp_ns )

inline

在文件 message_header.h 第 57 行定义.

                                               {
    Convert64ToArray(timestamp_ns, const_cast<char*>(timestamp_ns_));
  }

src_id()

uint64_t apollo::cyber::message::MessageHeader::src_id ( ) const

inline

在文件 message_header.h 第 62 行定义.

{ return ConvertArrayTo64(src_id_); }

timestamp_ns()

uint64_t apollo::cyber::message::MessageHeader::timestamp_ns ( ) const

inline

在文件 message_header.h 第 56 行定义.

{ return ConvertArrayTo64(timestamp_ns_); }

---

该类的文档由以下文件生成:

• cyber/message/message_header.h