This class represents the structure SynDDSMessage defined by the user in the IDL file.
#include <SynDDSMessage.h>
|
eProsima_user_DllExport | SynDDSMessage () |
| Default constructor.
|
|
eProsima_user_DllExport | ~SynDDSMessage () |
| Default destructor.
|
|
eProsima_user_DllExport | SynDDSMessage (const SynDDSMessage &x) |
| Copy constructor.
|
|
eProsima_user_DllExport | SynDDSMessage (SynDDSMessage &&x) |
| Move constructor.
|
|
eProsima_user_DllExport SynDDSMessage & | operator= (const SynDDSMessage &x) |
| Copy assignment.
|
|
eProsima_user_DllExport SynDDSMessage & | operator= (SynDDSMessage &&x) |
| Move assignment.
|
|
eProsima_user_DllExport void | rank (uint32_t _rank) |
| This function sets a value in member rank.
|
|
eProsima_user_DllExport uint32_t | rank () const |
| This function returns the value of member rank.
|
|
eProsima_user_DllExport uint32_t & | rank () |
| This function returns a reference to member rank.
|
|
eProsima_user_DllExport void | data (const std::vector< uint8_t > &_data) |
| This function copies the value in member data.
|
|
eProsima_user_DllExport void | data (std::vector< uint8_t > &&_data) |
| This function moves the value in member data.
|
|
eProsima_user_DllExport const std::vector< uint8_t > & | data () const |
| This function returns a constant reference to member data.
|
|
eProsima_user_DllExport std::vector< uint8_t > & | data () |
| This function returns a reference to member data.
|
|
eProsima_user_DllExport void | serialize (eprosima::fastcdr::Cdr &cdr) const |
| This function serializes an object using CDR serialization.
|
|
eProsima_user_DllExport void | deserialize (eprosima::fastcdr::Cdr &cdr) |
| This function deserializes an object using CDR serialization.
|
|
eProsima_user_DllExport void | serializeKey (eprosima::fastcdr::Cdr &cdr) const |
| This function serializes the key members of an object using CDR serialization.
|
|
|
static eProsima_user_DllExport size_t | getMaxCdrSerializedSize (size_t current_alignment=0) |
| This function returns the maximum serialized size of an object depending on the buffer alignment.
|
|
static eProsima_user_DllExport size_t | getCdrSerializedSize (const SynDDSMessage &data, size_t current_alignment=0) |
| This function returns the serialized size of a data depending on the buffer alignment.
|
|
static eProsima_user_DllExport 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 eProsima_user_DllExport bool | isKeyDefined () |
| This function tells you if the Key has been defined for this type.
|
|
◆ SynDDSMessage() [1/2]
Copy constructor.
- Parameters
-
◆ SynDDSMessage() [2/2]
Move constructor.
- Parameters
-
◆ data() [1/4]
std::vector< uint8_t > & SynDDSMessage::data |
( |
| ) |
|
This function returns a reference to member data.
- Returns
- Reference to member data
◆ data() [2/4]
const std::vector< uint8_t > & SynDDSMessage::data |
( |
| ) |
const |
This function returns a constant reference to member data.
- Returns
- Constant reference to member data
◆ data() [3/4]
void SynDDSMessage::data |
( |
const std::vector< uint8_t > & | _data | ) |
|
This function copies the value in member data.
- Parameters
-
_data | New value to be copied in member data |
◆ data() [4/4]
void SynDDSMessage::data |
( |
std::vector< uint8_t > && | _data | ) |
|
This function moves the value in member data.
- Parameters
-
_data | New value to be moved in member data |
◆ deserialize()
void SynDDSMessage::deserialize |
( |
eprosima::fastcdr::Cdr & | cdr | ) |
|
This function deserializes an object using CDR serialization.
- Parameters
-
cdr | CDR serialization object. |
◆ getCdrSerializedSize()
size_t SynDDSMessage::getCdrSerializedSize |
( |
const SynDDSMessage & | data, |
|
|
size_t | current_alignment = 0 ) |
|
static |
This function returns the serialized size of a data depending on the buffer alignment.
- Parameters
-
data | Data which is calculated its serialized size. |
current_alignment | Buffer alignment. |
- Returns
- Serialized size.
◆ getKeyMaxCdrSerializedSize()
size_t SynDDSMessage::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.
- Parameters
-
current_alignment | Buffer alignment. |
- Returns
- Maximum serialized size.
◆ getMaxCdrSerializedSize()
size_t SynDDSMessage::getMaxCdrSerializedSize |
( |
size_t | current_alignment = 0 | ) |
|
|
static |
This function returns the maximum serialized size of an object depending on the buffer alignment.
- Parameters
-
current_alignment | Buffer alignment. |
- Returns
- Maximum serialized size.
◆ operator=() [1/2]
Copy assignment.
- Parameters
-
◆ operator=() [2/2]
Move assignment.
- Parameters
-
◆ rank() [1/3]
uint32_t & SynDDSMessage::rank |
( |
| ) |
|
This function returns a reference to member rank.
- Returns
- Reference to member rank
◆ rank() [2/3]
uint32_t SynDDSMessage::rank |
( |
| ) |
const |
This function returns the value of member rank.
- Returns
- Value of member rank
◆ rank() [3/3]
void SynDDSMessage::rank |
( |
uint32_t | _rank | ) |
|
This function sets a value in member rank.
- Parameters
-
_rank | New value for member rank |
◆ serialize()
void SynDDSMessage::serialize |
( |
eprosima::fastcdr::Cdr & | cdr | ) |
const |
This function serializes an object using CDR serialization.
- Parameters
-
cdr | CDR serialization object. |
◆ serializeKey()
void SynDDSMessage::serializeKey |
( |
eprosima::fastcdr::Cdr & | cdr | ) |
const |
This function serializes the key members of an object using CDR serialization.
- Parameters
-
cdr | CDR serialization object. |
The documentation for this class was generated from the following files:
- C:/M/B/src/chrono-9.0.1/src/chrono_synchrono/communication/dds/idl/SynDDSMessage.h
- C:/M/B/src/chrono-9.0.1/src/chrono_synchrono/communication/dds/idl/SynDDSMessage.cxx