dds::topic::PublicationBuiltinTopicData Class Reference

Entry created when a dds::pub::DataWriter is discovered in association with its dds::pub::Publisher. More...

#include <dds/topic/BuiltinTopic.hpp>

Public Member Functions
	TPublicationBuiltinTopicData ()
	Create a default PublicationBuiltinTopicData.
const dds::topic::BuiltinTopicKey &	key () const
	Get the DCPS key to distinguish entries.
const dds::topic::BuiltinTopicKey &	participant_key () const
	Get the DCPS key of the dds::domain::DomainParticipant to which the dds::pub::DataWriter belongs.
const dds::core::string &	topic_name () const
	Get the name of the related dds::topic::Topic.
const dds::core::string &	type_name () const
	Get the name of the type attached to the dds::topic::Topic.
const dds::core::policy::Durability &	durability () const
	Get the dds::core::policy::Durability policy of the corresponding dds::pub::DataWriter.
const dds::core::policy::DurabilityService &	durability_service () const
	Get the dds::core::policy::DurabilityService policy of the corresponding dds::pub::DataWriter.
const dds::core::policy::Deadline &	deadline () const
	Get the dds::core::policy::Deadline policy of the corresponding dds::pub::DataWriter.
const dds::core::policy::LatencyBudget &	latency_budget () const
	Get the dds::core::policy::LatencyBudget policy of the corresponding dds::pub::DataWriter.
const dds::core::policy::Liveliness &	liveliness () const
	Get the dds::core::policy::Liveliness policy of the corresponding dds::pub::DataWriter.
const dds::core::policy::Reliability &	reliability () const
	Get the dds::core::policy::Reliability policy of the corresponding dds::pub::DataWriter.
const dds::core::policy::Lifespan &	lifespan () const
	Get the dds::core::policy::Lifespan policy of the corresponding dds::pub::DataWriter.
const dds::core::policy::UserData &	user_data () const
	Get the dds::core::policy::UserData policy of the corresponding dds::pub::DataWriter.
const dds::core::policy::Ownership &	ownership () const
	Get the dds::core::policy::Ownership policy of the corresponding dds::pub::DataWriter.
const dds::core::policy::OwnershipStrength &	ownership_strength () const
	Get the dds::core::policy::OwnershipStrength policy of the corresponding dds::pub::DataWriter.
const dds::core::policy::DestinationOrder &	destination_order () const
	Get the dds::core::policy::DestinationOrder policy of the corresponding dds::pub::DataWriter.
const dds::core::policy::Presentation &	presentation () const
	Get the dds::core::policy::Presentation policy of the corresponding dds::pub::DataWriter.
const dds::core::policy::Partition &	partition () const
	Get the dds::core::policy::Partition policy of the corresponding dds::pub::DataWriter.
const dds::core::policy::TopicData &	topic_data () const
	Get the dds::core::policy::TopicData policy of the related dds::topic::Topic.
const dds::core::policy::GroupData &	group_data () const
	Get the dds::core::policy::GroupData policy of the dds::pub::Publisher to which the dds::pub::DataWriter belongs.
dds::core::optional < dds::core::xtypes::DynamicType >	type () const
	<<extension>> Get the type
const dds::core::optional < dds::core::xtypes::DynamicType > &	get_type_no_copy () const
	<<extension>> Get the type by reference if possible
const dds::topic::BuiltinTopicKey &	publisher_key () const
	<<extension>> Get the DCPS key of the dds::pub::Publisher to which the dds::pub::DataWriter belongs
const rti::core::policy::Property &	property () const
	<<extension>> Get the propagated name-value properties of the corresponding dds::pub::DataWriter.
const dds::core::vector < rti::core::Locator > &	unicast_locators () const
	<<extension>> Get the custom unicast locators that the endpoint can specify.
const rti::core::Guid &	virtual_guid () const
	<<extension>> Get the virtual rti::core::Guid associated to the dds::pub::DataWriter.
const rti::core::ProtocolVersion &	rtps_protocol_version () const
	<<extension>> Get the version number of the RTPS wire protocol used.
const rti::core::VendorId &	rtps_vendor_id () const
	<<extension>> Get the ID of the vendor implementing the RTPS wire protocol.
const rti::core::ProductVersion &	product_version () const
	<<extension>> Get the current version for RTI Connext.
const rti::core::policy::LocatorFilter &	locator_filter () const
	<<extension>> Get the locator filters of the corresponding dds::pub::DataWriter
bool	disable_positive_acks () const
	<<extension>> See whether or not a matching dds::sub::DataReader will send positive acknowledgments for reliability.
const rti::core::policy::EntityName &	publication_name () const
	<<extension>> Get the publication name and role name.
const rti::core::policy::Service &	service () const
	<<extension>> Get the Service policy

Detailed Description

Entry created when a dds::pub::DataWriter is discovered in association with its dds::pub::Publisher.

Data associated with the built-in topic dds::topic::publication_topic_name(). It contains QoS policies and additional information that apply to the remote dds::pub::DataWriter the related dds::pub::Publisher.

Member Function Documentation

dds::topic::PublicationBuiltinTopicData::TPublicationBuiltinTopicData ( )

inline

Create a default PublicationBuiltinTopicData.

const dds::topic::BuiltinTopicKey& dds::topic::PublicationBuiltinTopicData::key ( ) const

inline

Get the DCPS key to distinguish entries.

Returns

The key

const dds::topic::BuiltinTopicKey& dds::topic::PublicationBuiltinTopicData::participant_key ( ) const

inline

Get the DCPS key of the dds::domain::DomainParticipant to which the dds::pub::DataWriter belongs.

Returns

The DomainParticipant's key

const dds::core::string& dds::topic::PublicationBuiltinTopicData::topic_name ( ) const

inline

Get the name of the related dds::topic::Topic.

Returns

The topic name

const dds::core::string& dds::topic::PublicationBuiltinTopicData::type_name ( ) const

inline

Get the name of the type attached to the dds::topic::Topic.

Returns

The type name

const dds::core::policy::Durability& dds::topic::PublicationBuiltinTopicData::durability ( ) const

inline

Get the dds::core::policy::Durability policy of the corresponding dds::pub::DataWriter.

Returns

The Durability policy

const dds::core::policy::DurabilityService& dds::topic::PublicationBuiltinTopicData::durability_service ( ) const

inline

Get the dds::core::policy::DurabilityService policy of the corresponding dds::pub::DataWriter.

Returns

The DurabilityService policy

const dds::core::policy::Deadline& dds::topic::PublicationBuiltinTopicData::deadline ( ) const

inline

Get the dds::core::policy::Deadline policy of the corresponding dds::pub::DataWriter.

Returns

The Deadline policy

const dds::core::policy::LatencyBudget& dds::topic::PublicationBuiltinTopicData::latency_budget ( ) const

inline

Get the dds::core::policy::LatencyBudget policy of the corresponding dds::pub::DataWriter.

Returns

The LatencyBudget policy

const dds::core::policy::Liveliness& dds::topic::PublicationBuiltinTopicData::liveliness ( ) const

inline

Get the dds::core::policy::Liveliness policy of the corresponding dds::pub::DataWriter.

Returns

The Liveliness policy

const dds::core::policy::Reliability& dds::topic::PublicationBuiltinTopicData::reliability ( ) const

inline

Get the dds::core::policy::Reliability policy of the corresponding dds::pub::DataWriter.

Returns

The Reliability policy

const dds::core::policy::Lifespan& dds::topic::PublicationBuiltinTopicData::lifespan ( ) const

inline

Get the dds::core::policy::Lifespan policy of the corresponding dds::pub::DataWriter.

Returns

The Lifespan policy

const dds::core::policy::UserData& dds::topic::PublicationBuiltinTopicData::user_data ( ) const

inline

Get the dds::core::policy::UserData policy of the corresponding dds::pub::DataWriter.

Returns

The UserData policy

const dds::core::policy::Ownership& dds::topic::PublicationBuiltinTopicData::ownership ( ) const

inline

Get the dds::core::policy::Ownership policy of the corresponding dds::pub::DataWriter.

Returns

The Ownership policy

const dds::core::policy::OwnershipStrength& dds::topic::PublicationBuiltinTopicData::ownership_strength ( ) const

inline

Get the dds::core::policy::OwnershipStrength policy of the corresponding dds::pub::DataWriter.

Returns

The OwnershipStrength policy

const dds::core::policy::DestinationOrder& dds::topic::PublicationBuiltinTopicData::destination_order ( ) const

inline

Get the dds::core::policy::DestinationOrder policy of the corresponding dds::pub::DataWriter.

Returns

The DestinationOrder policy

const dds::core::policy::Presentation& dds::topic::PublicationBuiltinTopicData::presentation ( ) const

inline

Get the dds::core::policy::Presentation policy of the corresponding dds::pub::DataWriter.

Returns

The Presentation policy

const dds::core::policy::Partition& dds::topic::PublicationBuiltinTopicData::partition ( ) const

inline

Get the dds::core::policy::Partition policy of the corresponding dds::pub::DataWriter.

Returns

The Partition policy

const dds::core::policy::TopicData& dds::topic::PublicationBuiltinTopicData::topic_data ( ) const

inline

Get the dds::core::policy::TopicData policy of the related dds::topic::Topic.

Returns

The TopicData policy

const dds::core::policy::GroupData& dds::topic::PublicationBuiltinTopicData::group_data ( ) const

inline

Get the dds::core::policy::GroupData policy of the dds::pub::Publisher to which the dds::pub::DataWriter belongs.

Returns

The GroupData policy

dds::core::optional< dds::core::xtypes::DynamicType > type

(

)

const

<<extension>> Get the type

Note

This is not a lightweight getter–obtaining the type may require some processing so it is recommended that you keep the value if you need to use it multiple times rather than look it up every time. See also get_type_no_copy().

Returns

The type or an unset optional value if the type is not available

const dds::core::optional< dds::core::xtypes::DynamicType > & get_type_no_copy

(

)

const

<<extension>> Get the type by reference if possible

Exceptions

dds::core::PreconditionNotMet

If the type is available but is not in a format that is directly accessible. In that case it needs some extra processing and has to be accessed using type(). You can also ensure that it is in the right format by setting rti::core::policy::DomainParticipantResourceLimits::type_code_max_serialized_length() to 0.

Returns

The type or an unset optional value if the type is not available

See Also

type()

const dds::topic::BuiltinTopicKey & publisher_key

(

)

const

<<extension>> Get the DCPS key of the dds::pub::Publisher to which the dds::pub::DataWriter belongs

Returns

The key

const rti::core::policy::Property & property

(

)

const

<<extension>> Get the propagated name-value properties of the corresponding dds::pub::DataWriter.

Returns

The properties

const dds::core::vector< rti::core::Locator > & unicast_locators

(

)

const

<<extension>> Get the custom unicast locators that the endpoint can specify.

The default locators will be used if this is not specified.

Returns

The custom unicast locators specified by the corresponding DataWriter

const rti::core::Guid & virtual_guid

(

)

const

<<extension>> Get the virtual rti::core::Guid associated to the dds::pub::DataWriter.

Returns

The virtual guid

const rti::core::ProtocolVersion & rtps_protocol_version

(

)

const

<<extension>> Get the version number of the RTPS wire protocol used.

Returns

The RTPS wire protocol version

const rti::core::VendorId & rtps_vendor_id

(

)

const

<<extension>> Get the ID of the vendor implementing the RTPS wire protocol.

Returns

The vendor ID

const rti::core::ProductVersion & product_version

(

)

const

<<extension>> Get the current version for RTI Connext.

Returns

The

const rti::core::policy::LocatorFilter & locator_filter

(

)

const

<<extension>> Get the locator filters of the corresponding dds::pub::DataWriter

Returns

The rti::core::LocatorFilterQosPolicy

See Also

rti::core::policy::MultiChannel

bool disable_positive_acks

(

)

const

<<extension>> See whether or not a matching dds::sub::DataReader will send positive acknowledgments for reliability.

Returns

true if positive acks are disabled, false otherwise

const rti::core::policy::EntityName & publication_name

(

)

const

<<extension>> Get the publication name and role name.

Returns

The rti::core::policy::EntityName policy of the corresponding DataWriter

Examples:

USER_QOS_PROFILES.xml.

const rti::core::policy::Service & service

(

)

const

<<extension>> Get the Service policy