Class WriterProxyData

Class Documentation

class WriterProxyData

Public Functions

RTPS_DllAPI WriterProxyData(const size_t max_unicast_locators, const size_t max_multicast_locators)
RTPS_DllAPI WriterProxyData(const size_t max_unicast_locators, const size_t max_multicast_locators, const VariableLengthDataLimits &data_limits)
virtual RTPS_DllAPI ~WriterProxyData()
RTPS_DllAPI WriterProxyData(const WriterProxyData &writerInfo)
RTPS_DllAPI WriterProxyData & operator= (const WriterProxyData &writerInfo)
inline RTPS_DllAPI void guid (const GUID_t &guid)
inline RTPS_DllAPI void guid (GUID_t &&guid)
inline RTPS_DllAPI const GUID_t & guid () const
inline RTPS_DllAPI GUID_t & guid ()
inline RTPS_DllAPI void persistence_guid (const GUID_t &guid)
inline RTPS_DllAPI void persistence_guid (GUID_t &&guid)
inline RTPS_DllAPI GUID_t persistence_guid () const
inline RTPS_DllAPI GUID_t & persistence_guid ()
inline RTPS_DllAPI void set_persistence_entity_id (const EntityId_t &nid)
inline RTPS_DllAPI bool has_locators () const
inline RTPS_DllAPI const RemoteLocatorList & remote_locators () const
RTPS_DllAPI void add_unicast_locator (const Locator_t &locator)
void set_announced_unicast_locators(const LocatorList_t &locators)
void set_remote_unicast_locators(const LocatorList_t &locators, const NetworkFactory &network)
RTPS_DllAPI void add_multicast_locator (const Locator_t &locator)
void set_multicast_locators(const LocatorList_t &locators, const NetworkFactory &network)
void set_locators(const RemoteLocatorList &locators)
void set_remote_locators(const RemoteLocatorList &remote_locators, const NetworkFactory &network, bool use_multicast_locators)
inline RTPS_DllAPI void key (const InstanceHandle_t &key)
inline RTPS_DllAPI void key (InstanceHandle_t &&key)
inline RTPS_DllAPI InstanceHandle_t key () const
inline RTPS_DllAPI InstanceHandle_t & key ()
inline RTPS_DllAPI void RTPSParticipantKey (const InstanceHandle_t &RTPSParticipantKey)
inline RTPS_DllAPI void RTPSParticipantKey (InstanceHandle_t &&RTPSParticipantKey)
inline RTPS_DllAPI InstanceHandle_t RTPSParticipantKey () const
inline RTPS_DllAPI InstanceHandle_t & RTPSParticipantKey ()
inline RTPS_DllAPI void typeName (const string_255 &typeName)
inline RTPS_DllAPI void typeName (string_255 &&typeName)
inline RTPS_DllAPI const string_255 & typeName () const
inline RTPS_DllAPI string_255 & typeName ()
inline RTPS_DllAPI void topicName (const string_255 &topicName)
inline RTPS_DllAPI void topicName (string_255 &&topicName)
inline RTPS_DllAPI const string_255 & topicName () const
inline RTPS_DllAPI string_255 & topicName ()
inline RTPS_DllAPI void userDefinedId (uint16_t userDefinedId)
inline RTPS_DllAPI uint16_t userDefinedId () const
inline RTPS_DllAPI uint16_t & userDefinedId ()
inline RTPS_DllAPI void typeMaxSerialized (uint32_t typeMaxSerialized)
inline RTPS_DllAPI uint32_t typeMaxSerialized () const
inline RTPS_DllAPI uint32_t & typeMaxSerialized ()
inline RTPS_DllAPI void topicKind (TopicKind_t topicKind)
inline RTPS_DllAPI TopicKind_t topicKind () const
inline RTPS_DllAPI TopicKind_t & topicKind ()
inline RTPS_DllAPI void type_id (const TypeIdV1 &other_type_id)
inline RTPS_DllAPI const TypeIdV1 & type_id () const
inline RTPS_DllAPI TypeIdV1 & type_id ()
inline RTPS_DllAPI bool has_type_id () const
inline RTPS_DllAPI void type (const TypeObjectV1 &other_type)
inline RTPS_DllAPI const TypeObjectV1 & type () const
inline RTPS_DllAPI TypeObjectV1 & type ()
inline RTPS_DllAPI bool has_type () const
inline RTPS_DllAPI void type_information (const xtypes::TypeInformation &other_type_information)
inline RTPS_DllAPI const xtypes::TypeInformation & type_information () const
inline RTPS_DllAPI xtypes::TypeInformation & type_information ()
inline RTPS_DllAPI bool has_type_information () const
inline void set_sample_identity(const SampleIdentity &sid)

Set participant client server sample identity

Parameters

sid – valid SampleIdentity

inline SampleIdentity get_sample_identity() const

Retrieve participant SampleIdentity

Returns

SampleIdentity

void clear()

Clear the information and return the object to the default state.

bool is_update_allowed(const WriterProxyData &wdata) const

Check if this object can be updated with the information on another object.

Parameters

wdata – WriterProxyData object to be checked.

Returns

true if this object can be updated with the information on wdata.

void update(WriterProxyData *wdata)

Update certain parameters from another object.

Parameters

wdata – pointer to object with new information.

void copy(WriterProxyData *wdata)

Copy all information from another object.

uint32_t get_serialized_size(bool include_encapsulation) const

Get the size in bytes of the CDR serialization of this object.

Parameters

include_encapsulation – Whether to include the size of the encapsulation info.

Returns

size in bytes of the CDR serialization.

bool writeToCDRMessage(CDRMessage_t *msg, bool write_encapsulation) const

Write as a parameter list on a CDRMessage_t.

RTPS_DllAPI bool readFromCDRMessage (CDRMessage_t *msg, const NetworkFactory &network, bool is_shm_transport_possible)

Read a parameter list from a CDRMessage_t.

Public Members

WriterQos m_qos

WriterQOS.