RTI Connext Modern C++ API  Version 7.0.0
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. More...
 
const dds::topic::BuiltinTopicKeykey () const
 Get the DCPS key to distinguish entries. More...
 
const dds::topic::BuiltinTopicKeyparticipant_key () const
 Get the DCPS key of the dds::domain::DomainParticipant to which the dds::pub::DataWriter belongs. More...
 
const dds::core::stringtopic_name () const
 Get the name of the related dds::topic::Topic. More...
 
const dds::core::stringtype_name () const
 Get the name of the type attached to the dds::topic::Topic. More...
 
const dds::core::policy::Durabilitydurability () const
 Get the dds::core::policy::Durability policy of the corresponding dds::pub::DataWriter. More...
 
const dds::core::policy::DurabilityServicedurability_service () const
 Get the dds::core::policy::DurabilityService policy of the corresponding dds::pub::DataWriter. More...
 
const dds::core::policy::Deadlinedeadline () const
 Get the dds::core::policy::Deadline policy of the corresponding dds::pub::DataWriter. More...
 
const dds::core::policy::LatencyBudgetlatency_budget () const
 Get the dds::core::policy::LatencyBudget policy of the corresponding dds::pub::DataWriter. More...
 
const dds::core::policy::Livelinessliveliness () const
 Get the dds::core::policy::Liveliness policy of the corresponding dds::pub::DataWriter. More...
 
const dds::core::policy::Reliabilityreliability () const
 Get the dds::core::policy::Reliability policy of the corresponding dds::pub::DataWriter. More...
 
const dds::core::policy::Lifespanlifespan () const
 Get the dds::core::policy::Lifespan policy of the corresponding dds::pub::DataWriter. More...
 
const dds::core::policy::UserDatauser_data () const
 Get the dds::core::policy::UserData policy of the corresponding dds::pub::DataWriter. More...
 
const dds::core::policy::Ownershipownership () const
 Get the dds::core::policy::Ownership policy of the corresponding dds::pub::DataWriter. More...
 
const dds::core::policy::OwnershipStrengthownership_strength () const
 Get the dds::core::policy::OwnershipStrength policy of the corresponding dds::pub::DataWriter. More...
 
const dds::core::policy::DestinationOrderdestination_order () const
 Get the dds::core::policy::DestinationOrder policy of the corresponding dds::pub::DataWriter. More...
 
const dds::core::policy::Presentationpresentation () const
 Get the dds::core::policy::Presentation policy of the corresponding dds::pub::DataWriter. More...
 
const dds::core::policy::Partitionpartition () const
 Get the dds::core::policy::Partition policy of the corresponding dds::pub::DataWriter. More...
 
const dds::core::policy::TopicDatatopic_data () const
 Get the dds::core::policy::TopicData policy of the related dds::topic::Topic. More...
 
const dds::core::policy::GroupDatagroup_data () const
 Get the dds::core::policy::GroupData policy of the dds::pub::Publisher to which the dds::pub::DataWriter belongs. More...
 
const dds::core::policy::DataRepresentationrepresentation () const
 Get the dds::core::policy::DataRepresentation policy of the corresponding dds::pub::DataWriter. More...
 
const dds::core::policy::DataTagdata_tag () const
 Get the dds::core::policy::DataTag policy of the corresponding dds::pub::DataWriter. More...
 
const dds::core::policy::DataRepresentationrepresentation () const
 Get the publication data representation. More...
 
dds::core::optional< dds::core::xtypes::DynamicTypetype () const
 <<extension>> Get the type More...
 
const dds::core::optional< dds::core::xtypes::DynamicType > & get_type_no_copy () const
 <<extension>> Get the type by reference if possible More...
 
const dds::topic::BuiltinTopicKeypublisher_key () const
 <<extension>> Get the DCPS key of the dds::pub::Publisher to which the dds::pub::DataWriter belongs More...
 
const rti::core::policy::Propertyproperty () const
 <<extension>> Get the propagated name-value properties of the corresponding dds::pub::DataWriter. More...
 
const dds::core::vector< rti::core::Locator > & unicast_locators () const
 <<extension>> Get the custom unicast locators that the endpoint can specify. More...
 
const rti::core::Guidvirtual_guid () const
 <<extension>> Get the virtual rti::core::Guid associated to the dds::pub::DataWriter. More...
 
const rti::core::ProtocolVersionrtps_protocol_version () const
 <<extension>> Get the version number of the RTPS wire protocol used. More...
 
const rti::core::VendorIdrtps_vendor_id () const
 <<extension>> Get the ID of the vendor implementing the RTPS wire protocol. More...
 
const rti::core::ProductVersionproduct_version () const
 <<extension>> Get the current version for RTI Connext. More...
 
const rti::core::policy::LocatorFilterlocator_filter () const
 <<extension>> Get the locator filters of the corresponding dds::pub::DataWriter More...
 
bool disable_positive_acks () const
 <<extension>> See whether or not a matching dds::sub::DataReader will send positive acknowledgments for reliability. More...
 
const rti::core::policy::EntityNamepublication_name () const
 <<extension>> Get the publication name and role name. More...
 
const rti::topic::trust::EndpointTrustInfotrust_info () const
 <<extension>> Get the Trust Plugins information associated with the discovered DataWriter. More...
 
const rti::topic::trust::EndpointTrustAlgorithmstrust_algorithms () const
 <<extension>> Get the Trust plugins algorithms associated with the discovered DataWriter. More...
 
const rti::core::policy::Serviceservice () const
 <<extension>> Get the Service policy More...
 

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

◆ TPublicationBuiltinTopicData()

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

Create a default PublicationBuiltinTopicData.

◆ key()

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

Get the DCPS key to distinguish entries.

Returns
The key

◆ participant_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

◆ topic_name()

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

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

Returns
The topic name

◆ type_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

◆ durability()

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

◆ durability_service()

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

◆ deadline()

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

◆ latency_budget()

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

◆ liveliness()

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

◆ reliability()

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

◆ lifespan()

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

◆ user_data()

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

◆ ownership()

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

◆ ownership_strength()

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

◆ destination_order()

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

◆ presentation()

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

◆ partition()

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

◆ topic_data()

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

◆ group_data()

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

◆ representation() [1/2]

const dds::core::policy::DataRepresentation& dds::topic::PublicationBuiltinTopicData::representation ( ) const
inline

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

Returns
The DataRepresentation policy

◆ data_tag()

const dds::core::policy::DataTag& dds::topic::PublicationBuiltinTopicData::data_tag ( ) const
inline

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

Returns
The DataTag policy

◆ representation() [2/2]

const dds::core::policy::DataRepresentation & representation ( ) const

Get the publication data representation.

Returns
The dds::core::policy::DataRepresentation policy of the corresponding DataWriter

◆ type()

<<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

◆ get_type_no_copy()

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

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

Exceptions
dds::core::PreconditionNotMetIf 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()

◆ publisher_key()

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

◆ property()

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

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

Returns
The properties

◆ unicast_locators()

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

◆ virtual_guid()

const rti::core::Guid & virtual_guid ( ) const

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

Returns
The virtual guid

◆ rtps_protocol_version()

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

◆ rtps_vendor_id()

const rti::core::VendorId & rtps_vendor_id ( ) const

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

Returns
The vendor ID

◆ product_version()

const rti::core::ProductVersion & product_version ( ) const

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

Returns
The

◆ locator_filter()

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

◆ disable_positive_acks()

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

◆ publication_name()

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

◆ trust_info()

const rti::topic::trust::EndpointTrustInfo & trust_info ( ) const

<<extension>> Get the Trust Plugins information associated with the discovered DataWriter.

Trust Plugins is a generic abstraction that represents any plugin intended to do transformation, interception, and validation of exchanged data and metadata.

trust_info contains information about how RTPS wire serialization, discovery, and liveliness interact with the loaded Trust Plugins. Two endpoints will not match if their trust_info is incompatible.

The meaning of the contents of this field may vary depending on what Trust Plugins the endpoint is using. For information about how this field interacts with the RTI Security Plugins, please refer to the RTI Security Plugins User's Manual.

◆ trust_algorithms()

const rti::topic::trust::EndpointTrustAlgorithms & trust_algorithms ( ) const

<<extension>> Get the Trust plugins algorithms associated with the discovered DataWriter.

Trust Plugins is a generic abstraction that represents any plugin intended to do transformation, interception, and validation of exchanged data and metadata.

trust_algorithms contains information about what algorithms the loaded Trust Plugins are running. Two endpoints will not match if their trust_algorithms are incompatible.

The meaning of the contents of this field may vary depending on what Trust Plugins the endpoint is using. For information about how this field interacts with the RTI Security Plugins, please refer to the RTI Security Plugins User's Manual.

◆ service()

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