The Entity class is the abstract base class for all the objects that support QoS policies, a listener and a status condition. More...
#include <Entity.hpp>
Public Member Functions | |
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. | |
Protected Member Functions | |
FASTDDS_EXPORTED_API void | set_instance_handle (const InstanceHandle_t &handle) |
Setter for the Instance Handle. | |
Protected Attributes | |
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. | |
The Entity class is the abstract base class for all the objects that support QoS policies, a listener and a status condition.
|
inline |
Constructor.
mask | StatusMask (default: all) |
|
inline |
This operation disables the Entity before closing it.
|
inlinevirtual |
This operation enables the Entity.
Reimplemented in DataReader, DataWriter, DomainParticipant, Publisher, and Subscriber.
|
inline |
Retrieves the instance handler that represents the Entity.
FASTDDS_EXPORTED_API const StatusMask & get_status_changes | ( | ) | const |
Retrieves the set of triggered statuses in the Entity.
Triggered statuses are the ones whose value has changed since the last time the application read the status. When the entity is first created or if the entity is not enabled, all communication statuses are in the non-triggered state, so the list returned by the get_status_changes operation will be empty. The list of statuses returned by the get_status_changes operation refers to the status that are triggered on the Entity itself and does not include statuses that apply to contained entities.
|
inline |
Retrieves the set of relevant statuses for the Entity.
|
inline |
Allows access to the StatusCondition associated with the Entity.
|
inline |
Checks if the Entity is enabled.
|
inline |
|
inlineprotected |
Setter for the Instance Handle.
handle | Instance Handle |
|
protected |
Boolean that states if the Entity is enabled or disabled.
|
protected |
InstanceHandle associated to the Entity.
|
protected |
|
protected |
StatusMask with relevant statuses set to 1.