Class Topic, represents the fact that both publications and subscriptions are tied to a single data-type. More...
#include <Topic.hpp>
Public Member Functions | |
virtual | ~Topic () |
virtual DomainParticipant * | get_participant () const override |
Getter for the DomainParticipant. | |
FASTDDS_EXPORTED_API ReturnCode_t | get_inconsistent_topic_status (InconsistentTopicStatus &status) |
Allows the application to retrieve the INCONSISTENT_TOPIC_STATUS status of a Topic. | |
FASTDDS_EXPORTED_API const TopicQos & | get_qos () const |
Allows accessing the Topic Qos. | |
FASTDDS_EXPORTED_API ReturnCode_t | get_qos (TopicQos &qos) const |
Retrieves the Topic Qos. | |
FASTDDS_EXPORTED_API ReturnCode_t | set_qos (const TopicQos &qos) |
Allows modifying the Topic Qos. | |
FASTDDS_EXPORTED_API const TopicListener * | get_listener () const |
Retrieves the attached TopicListener. | |
FASTDDS_EXPORTED_API ReturnCode_t | set_listener (TopicListener *listener, const StatusMask &mask=StatusMask::all()) |
Modifies the TopicListener. | |
TopicDescriptionImpl * | get_impl () const override |
![]() | |
DomainEntity (const StatusMask &mask=StatusMask::all()) | |
Constructor. | |
![]() | |
FASTDDS_EXPORTED_API | Entity (const StatusMask &mask=StatusMask::all()) |
Constructor. | |
virtual ReturnCode_t | enable () |
This operation enables the Entity. | |
void | close () |
This operation disables the Entity before closing it. | |
FASTDDS_EXPORTED_API const StatusMask & | get_status_mask () const |
Retrieves the set of relevant statuses for the Entity. | |
FASTDDS_EXPORTED_API const StatusMask & | get_status_changes () const |
Retrieves the set of triggered statuses in the Entity. | |
const InstanceHandle_t & | get_instance_handle () const |
Retrieves the instance handler that represents the Entity. | |
FASTDDS_EXPORTED_API bool | is_enabled () const |
Checks if the Entity is enabled. | |
FASTDDS_EXPORTED_API bool | operator== (const Entity &other) const |
FASTDDS_EXPORTED_API StatusCondition & | get_statuscondition () |
Allows access to the StatusCondition associated with the Entity. | |
![]() | |
const std::string & | get_name () const |
Get the name used to create this TopicDescription. | |
const std::string & | get_type_name () const |
Get the associated type name. | |
Protected Attributes | |
TopicProxy * | impl_ |
![]() | |
StatusMask | status_mask_ |
StatusMask with relevant statuses set to 1. | |
StatusCondition | status_condition_ |
Condition associated to the Entity. | |
InstanceHandle_t | instance_handle_ |
InstanceHandle associated to the Entity. | |
bool | enable_ |
Boolean that states if the Entity is enabled or disabled. | |
![]() | |
std::string | name_ |
Name that allows the TopicDescription to be retrieved locally. | |
std::string | type_name_ |
Name that defines a unique resulting type for the publication or the subscription. | |
Friends | |
class | TopicProxy |
class | DomainParticipantImpl |
class | ::dds::topic::Topic |
Additional Inherited Members | |
![]() | |
FASTDDS_EXPORTED_API void | set_instance_handle (const InstanceHandle_t &handle) |
Setter for the Instance Handle. | |
![]() | |
TopicDescription (const std::string &name, const std::string &type_name) | |
virtual | ~TopicDescription () |
Class Topic, represents the fact that both publications and subscriptions are tied to a single data-type.
|
virtual |
|
overridevirtual |
Implements TopicDescription.
FASTDDS_EXPORTED_API ReturnCode_t get_inconsistent_topic_status | ( | InconsistentTopicStatus & | status | ) |
Allows the application to retrieve the INCONSISTENT_TOPIC_STATUS status of a Topic.
status | [out] Status to be retrieved. |
FASTDDS_EXPORTED_API const TopicListener * get_listener | ( | ) | const |
Retrieves the attached TopicListener.
|
overridevirtual |
FASTDDS_EXPORTED_API const TopicQos & get_qos | ( | ) | const |
FASTDDS_EXPORTED_API ReturnCode_t get_qos | ( | TopicQos & | qos | ) | const |
FASTDDS_EXPORTED_API ReturnCode_t set_listener | ( | TopicListener * | listener, |
const StatusMask & | mask = StatusMask::all() |
||
) |
Modifies the TopicListener.
listener | new value for the TopicListener |
mask | StatusMask that holds statuses the listener responds to (default: all). |
FASTDDS_EXPORTED_API ReturnCode_t set_qos | ( | const TopicQos & | qos | ) |
|
friend |
|
friend |
|
friend |
|
protected |