RTI Connext DDS Micro C++ API
Version 4.0.1
|
<<interface>> The most basic description of the data to be published and subscribed. More...
#include <dds_cpp_topic.hxx>
Public Member Functions | |
virtual DDSTopicDescription * | as_topicdescription ()=0 |
<<cert>> Access a DDSTopic's DDSTopicDescription supertype instance. | |
virtual DDSEntity * | as_entity ()=0 |
<<cert>> Access a DDSTopic's DDSEntity supertype instance. | |
virtual DDS_ReturnCode_t | set_qos (const DDS_TopicQos &qos)=0 |
Set the topic QoS. | |
virtual DDS_ReturnCode_t | get_qos (DDS_TopicQos &qos)=0 |
Get the topic QoS. | |
virtual DDS_ReturnCode_t | get_inconsistent_topic_status (DDS_InconsistentTopicStatus &status)=0 |
<<cert>> Allows the application to retrieve the DDS_INCONSISTENT_TOPIC_STATUS status of a DDSTopic. | |
virtual DDS_ReturnCode_t | set_listener (const DDSTopicListener *listener, DDS_StatusMask mask)=0 |
Set the topic listener. | |
virtual DDSTopicListener * | get_listener ()=0 |
Get the topic listener. | |
virtual const char * | get_type_name ()=0 |
<<cert>> Get the associated type_name . | |
virtual const char * | get_name ()=0 |
<<cert>> Get the name used to create this DDSTopicDescription . | |
virtual DDSDomainParticipant * | get_participant ()=0 |
<<cert>> Get the DDSDomainParticipant to which the DDSTopicDescription belongs. | |
![]() | |
DDS_ReturnCode_t | enable () |
<<cert>> Enables the DDSEntity. | |
DDSStatusCondition * | get_statuscondition () |
<<cert>> Return the DDSStatusCondition associated with a particular DDSEntity. | |
DDS_StatusMask | get_status_changes () |
<<cert>> Retrieves the list of communication statuses in the DDSEntity that are triggered. | |
DDS_InstanceHandle_t | get_instance_handle () |
<<cert>> Allows access to the DDS_InstanceHandle_t associated with the DDSEntity. |
Static Public Member Functions | |
static DDSTopic * | narrow (DDSTopicDescription *topic_description) |
<<cert>> Narrow the given DDSTopicDescription pointer to a DDSTopic pointer. |
<<interface>> The most basic description of the data to be published and subscribed.
A DDSTopic is identified by its name, which must be unique in the whole domain. In addition (by virtue of extending DDSTopicDescription) it fully specifies the type of the data that can be communicated when publishing or subscribing to the DDSTopic.
DDSTopic is the only DDSTopicDescription that can be used for publications and therefore associated with a DDSDataWriter.
The following operations may be called even if the DDSTopic is not enabled. Other operations will fail with the value DDS_RETCODE_NOT_ENABLED if called on a disabled DDSTopic:
|
static |
<<cert>> Narrow the given DDSTopicDescription pointer to a DDSTopic pointer.
|
pure virtual |
<<cert>> Access a DDSTopic's DDSTopicDescription supertype instance.
|
pure virtual |
|
pure virtual |
Set the topic QoS.
Policies must be consistent. Policies cannot be changed after DDSTopic is enabled. The special value DDS_TOPIC_QOS_DEFAULT can be used to indicate that the QoS of the DDSTopic should be changed to match the current default DDS_TopicQos set in the DDSDomainParticipant.
|
pure virtual |
Get the topic QoS.
This method may potentially allocate memory depending on the sequences contained in some QoS policies.
qos | <<inout>> QoS to be filled up. |
|
pure virtual |
<<cert>> Allows the application to retrieve the DDS_INCONSISTENT_TOPIC_STATUS status of a DDSTopic.
Retrieve the current DDS_InconsistentTopicStatus
status | <<inout>> Status to be retrieved. |
|
pure virtual |
Set the topic listener.
listener | <<in>> Listener to be installed on entity. |
mask | <<in>> Changes of communication status to be invoked on the listener. |
|
pure virtual |
Get the topic listener.
|
pure virtual |
<<cert>> Get the associated type_name
.
The type name defines a locally unique type for the publication or the subscription.
The type_name
corresponds to a unique string used to register a type via the DDSDomainParticipant::register_type method.
Thus, the type_name
implies an association with a corresponding type and this DDSTopicDescription.
Implements DDSTopicDescription.
|
pure virtual |
<<cert>> Get the name used to create this DDSTopicDescription .
Implements DDSTopicDescription.
|
pure virtual |
<<cert>> Get the DDSDomainParticipant to which the DDSTopicDescription belongs.
Implements DDSTopicDescription.