apollo::cyber::transport::UnderlayMessage类 参考

This class represents the structure UnderlayMessage defined by the user in the IDL file. 更多...

#include <underlay_message.h>

apollo::cyber::transport::UnderlayMessage 的协作图:

Public 成员函数
	UnderlayMessage ()
	Default constructor.
	~UnderlayMessage ()
	Default destructor.
	UnderlayMessage (const UnderlayMessage &x)
	Copy constructor.
	UnderlayMessage (UnderlayMessage &&x)
	Move constructor.
UnderlayMessage &	operator= (const UnderlayMessage &x)
	Copy assignment.
UnderlayMessage &	operator= (UnderlayMessage &&x)
	Move assignment.
void	timestamp (int32_t _timestamp)
	This function sets a value in member timestamp
int32_t	timestamp () const
	This function returns the value of member timestamp
int32_t &	timestamp ()
	This function returns a reference to member timestamp
void	seq (int32_t _seq)
	This function sets a value in member seq
int32_t	seq () const
	This function returns the value of member seq
int32_t &	seq ()
	This function returns a reference to member seq
void	data (const std::string &_data)
	This function copies the value in member data
void	data (std::string &&_data)
	This function moves the value in member data
const std::string &	data () const
	This function returns a constant reference to member data
std::string &	data ()
	This function returns a reference to member data
void	datatype (const std::string &_datatype)
	This function copies the value in member datatype
void	datatype (std::string &&_datatype)
	This function moves the value in member datatype
const std::string &	datatype () const
	This function returns a constant reference to member datatype
std::string &	datatype ()
	This function returns a reference to member datatype
void	serialize (eprosima::fastcdr::Cdr &cdr) const
	This function serializes an object using CDR serialization.
void	deserialize (eprosima::fastcdr::Cdr &cdr)
	This function deserializes an object using CDR serialization.
void	serializeKey (eprosima::fastcdr::Cdr &cdr) const
	This function serializes the key members of an object using CDR serialization.

静态 Public 成员函数
static size_t	getMaxCdrSerializedSize (size_t current_alignment=0)
	This function returns the maximum serialized size of an object depending on the buffer alignment.
static size_t	getCdrSerializedSize (const UnderlayMessage &data, size_t current_alignment=0)
	This function returns the serialized size of a data depending on the buffer alignment.
static size_t	getKeyMaxCdrSerializedSize (size_t current_alignment=0)
	This function returns the maximum serialized size of the Key of an object depending on the buffer alignment.
static bool	isKeyDefined ()
	This function tells you if the Key has been defined for this type

详细描述

This class represents the structure UnderlayMessage defined by the user in the IDL file.

在文件 underlay_message.h 第 38 行定义.

构造及析构函数说明

UnderlayMessage() [1/3]

apollo::cyber::transport::UnderlayMessage::UnderlayMessage

(

)

Default constructor.

在文件 underlay_message.cc 第 31 行定义.

                                 {
  m_timestamp = 0;
  m_seq = 0;
}

~UnderlayMessage()

apollo::cyber::transport::UnderlayMessage::~UnderlayMessage

(

)

Default destructor.

在文件 underlay_message.cc 第 36 行定义.

{}

UnderlayMessage() [2/3]

apollo::cyber::transport::UnderlayMessage::UnderlayMessage

(

const UnderlayMessage &

x

)

Copy constructor.

参数

x	Reference to the object UnderlayMessage that will be copied.

在文件 underlay_message.cc 第 38 行定义.

                                                         {
  m_timestamp = x.m_timestamp;
  m_seq = x.m_seq;
  m_data = x.m_data;
  m_datatype = x.m_datatype;
}

UnderlayMessage() [3/3]

apollo::cyber::transport::UnderlayMessage::UnderlayMessage

(

UnderlayMessage &&

x

)

Move constructor.

参数

x	Reference to the object UnderlayMessage that will be copied.

在文件 underlay_message.cc 第 45 行定义.

                                                    {
  m_timestamp = x.m_timestamp;
  m_seq = x.m_seq;
  m_data = std::move(x.m_data);
  m_datatype = std::move(x.m_datatype);
}

成员函数说明

data() [1/4]

std::string & apollo::cyber::transport::UnderlayMessage::data ( )

inline

This function returns a reference to member data

返回

Reference to member data

在文件 underlay_message.h 第 130 行定义.

{ return m_data; }

data() [2/4]

const std::string & apollo::cyber::transport::UnderlayMessage::data ( ) const

inline

This function returns a constant reference to member data

返回

Constant reference to member data

在文件 underlay_message.h 第 124 行定义.

{ return m_data; }

data() [3/4]

void apollo::cyber::transport::UnderlayMessage::data ( const std::string &  _data )

inline

This function copies the value in member data

参数

_data

New value to be copied in member data

在文件 underlay_message.h 第 112 行定义.

{ m_data = _data; }

data() [4/4]

void apollo::cyber::transport::UnderlayMessage::data ( std::string &&  _data )

inline

This function moves the value in member data

参数

_data

New value to be moved in member data

在文件 underlay_message.h 第 118 行定义.

{ m_data = std::move(_data); }

datatype() [1/4]

std::string & apollo::cyber::transport::UnderlayMessage::datatype ( )

inline

This function returns a reference to member datatype

返回

Reference to member datatype

在文件 underlay_message.h 第 155 行定义.

{ return m_datatype; }

datatype() [2/4]

const std::string & apollo::cyber::transport::UnderlayMessage::datatype ( ) const

inline

This function returns a constant reference to member datatype

返回

Constant reference to member datatype

在文件 underlay_message.h 第 149 行定义.

{ return m_datatype; }

datatype() [3/4]

void apollo::cyber::transport::UnderlayMessage::datatype ( const std::string &  _datatype )

inline

This function copies the value in member datatype

参数

_datatype

New value to be copied in member datatype

在文件 underlay_message.h 第 135 行定义.

{ m_datatype = _datatype; }

datatype() [4/4]

void apollo::cyber::transport::UnderlayMessage::datatype ( std::string &&  _datatype )

inline

This function moves the value in member datatype

参数

_datatype

New value to be moved in member datatype

在文件 underlay_message.h 第 141 行定义.

                                              {
    m_datatype = std::move(_datatype);
  }

deserialize()

void apollo::cyber::transport::UnderlayMessage::deserialize

(

eprosima::fastcdr::Cdr &

cdr

)

This function deserializes an object using CDR serialization.

参数

cdr	CDR serialization object.

在文件 underlay_message.cc 第 118 行定义.

                                                          {
  dcdr >> m_timestamp;
  dcdr >> m_seq;
  dcdr >> m_data;
  dcdr >> m_datatype;
}

getCdrSerializedSize()

size_t apollo::cyber::transport::UnderlayMessage::getCdrSerializedSize ( const UnderlayMessage &  data, size_t  current_alignment = 0  )

static

This function returns the serialized size of a data depending on the buffer alignment.

参数

data	Data which is calculated its serialized size.
current_alignment	Buffer alignment.

返回

Serialized size.

在文件 underlay_message.cc 第 88 行定义.

                                                                       {
  size_t initial_alignment = current_alignment;
 
  current_alignment +=
      4 + eprosima::fastcdr::Cdr::alignment(current_alignment, 4);
 
  current_alignment +=
      4 + eprosima::fastcdr::Cdr::alignment(current_alignment, 4);
 
  current_alignment += 4 +
                       eprosima::fastcdr::Cdr::alignment(current_alignment, 4) +
                       data.data().size() + 1;
 
  current_alignment += 4 +
                       eprosima::fastcdr::Cdr::alignment(current_alignment, 4) +
                       data.datatype().size() + 1;
 
  return current_alignment - initial_alignment;
}

getKeyMaxCdrSerializedSize()

size_t apollo::cyber::transport::UnderlayMessage::getKeyMaxCdrSerializedSize ( size_t  current_alignment = 0 )

static

This function returns the maximum serialized size of the Key of an object depending on the buffer alignment.

参数

current_alignment

Buffer alignment.

返回

Maximum serialized size.

在文件 underlay_message.cc 第 125 行定义.

                                                                           {
  size_t current_align = current_alignment;
  return current_align;
}

getMaxCdrSerializedSize()

size_t apollo::cyber::transport::UnderlayMessage::getMaxCdrSerializedSize ( size_t  current_alignment = 0 )

static

This function returns the maximum serialized size of an object depending on the buffer alignment.

参数

current_alignment

Buffer alignment.

返回

Maximum serialized size.

在文件 underlay_message.cc 第 70 行定义.

                                                                        {
  size_t initial_alignment = current_alignment;
 
  current_alignment +=
      4 + eprosima::fastcdr::Cdr::alignment(current_alignment, 4);
 
  current_alignment +=
      4 + eprosima::fastcdr::Cdr::alignment(current_alignment, 4);
 
  current_alignment +=
      4 + eprosima::fastcdr::Cdr::alignment(current_alignment, 4) + 255 + 1;
 
  current_alignment +=
      4 + eprosima::fastcdr::Cdr::alignment(current_alignment, 4) + 255 + 1;
 
  return current_alignment - initial_alignment;
}

isKeyDefined()

bool apollo::cyber::transport::UnderlayMessage::isKeyDefined ( )

static

This function tells you if the Key has been defined for this type

在文件 underlay_message.cc 第 130 行定义.

{ return false; }

operator=() [1/2]

UnderlayMessage & apollo::cyber::transport::UnderlayMessage::operator=

(

const UnderlayMessage &

x

)

Copy assignment.

参数

x	Reference to the object UnderlayMessage that will be copied.

在文件 underlay_message.cc 第 52 行定义.

                                                                    {
  m_timestamp = x.m_timestamp;
  m_seq = x.m_seq;
  m_data = x.m_data;
  m_datatype = x.m_datatype;
 
  return *this;
}

operator=() [2/2]

UnderlayMessage & apollo::cyber::transport::UnderlayMessage::operator=

(

UnderlayMessage &&

x

)

Move assignment.

参数

x	Reference to the object UnderlayMessage that will be copied.

在文件 underlay_message.cc 第 61 行定义.

                                                               {
  m_timestamp = x.m_timestamp;
  m_seq = x.m_seq;
  m_data = std::move(x.m_data);
  m_datatype = std::move(x.m_datatype);
 
  return *this;
}

seq() [1/3]

int32_t & apollo::cyber::transport::UnderlayMessage::seq ( )

inline

This function returns a reference to member seq

返回

Reference to member seq

在文件 underlay_message.h 第 107 行定义.

{ return m_seq; }

seq() [2/3]

int32_t apollo::cyber::transport::UnderlayMessage::seq ( ) const

inline

This function returns the value of member seq

返回

Value of member seq

在文件 underlay_message.h 第 101 行定义.

{ return m_seq; }

seq() [3/3]

void apollo::cyber::transport::UnderlayMessage::seq ( int32_t  _seq )

inline

This function sets a value in member seq

参数

_seq	New value for member seq

在文件 underlay_message.h 第 95 行定义.

{ m_seq = _seq; }

serialize()

void apollo::cyber::transport::UnderlayMessage::serialize

(

eprosima::fastcdr::Cdr &

cdr

)

const

This function serializes an object using CDR serialization.

参数

cdr	CDR serialization object.

在文件 underlay_message.cc 第 109 行定义.

                                                              {
  scdr << m_timestamp;
 
  scdr << m_seq;
 
  scdr << m_data;
  scdr << m_datatype;
}

serializeKey()

void apollo::cyber::transport::UnderlayMessage::serializeKey

(

eprosima::fastcdr::Cdr &

cdr

)

const

This function serializes the key members of an object using CDR serialization.

参数

cdr	CDR serialization object.

在文件 underlay_message.cc 第 132 行定义.

                                                                 {
  (void)scdr;
}

timestamp() [1/3]

int32_t & apollo::cyber::transport::UnderlayMessage::timestamp ( )

inline

This function returns a reference to member timestamp

返回

Reference to member timestamp

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

{ return m_timestamp; }

timestamp() [2/3]

int32_t apollo::cyber::transport::UnderlayMessage::timestamp ( ) const

inline

This function returns the value of member timestamp

返回

Value of member timestamp

在文件 underlay_message.h 第 84 行定义.

{ return m_timestamp; }

timestamp() [3/3]

void apollo::cyber::transport::UnderlayMessage::timestamp ( int32_t  _timestamp )

inline

This function sets a value in member timestamp

参数

_timestamp

New value for member timestamp

在文件 underlay_message.h 第 78 行定义.

{ m_timestamp = _timestamp; }

---

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

• cyber/transport/rtps/underlay_message.h
• cyber/transport/rtps/underlay_message.cc