Class Entity

Inheritance Relationships

Derived Types

Class Documentation

class Entity

The Entity class is the abstract base class for all the objects that support QoS policies, a listener and a status condition.

Subclassed by eprosima::fastdds::dds::DomainEntity, eprosima::fastdds::dds::DomainParticipant

Public Functions

inline RTPS_DllAPI Entity(const StatusMask &mask = StatusMask::all())

Constructor.

Parameters

mask – StatusMask (default: all)

inline virtual fastrtps::types::ReturnCode_t enable()

This operation enables the Entity.

Returns

RETCODE_OK

inline void close()

This operation disables the Entity before closing it.

inline RTPS_DllAPI const StatusMask & get_status_mask () const

Retrieves the set of relevant statuses for the Entity.

Returns

Reference to the StatusMask with the relevant statuses set to 1

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

Returns

const reference to the StatusMask with the triggered statuses set to 1

inline const InstanceHandle_t &get_instance_handle() const

Retrieves the instance handler that represents the Entity.

Returns

Reference to the InstanceHandle

inline RTPS_DllAPI bool is_enabled () const

Checks if the Entity is enabled.

Returns

true if enabled, false if not

inline RTPS_DllAPI bool operator== (const Entity &other) const
inline RTPS_DllAPI StatusCondition & get_statuscondition ()

Allows access to the StatusCondition associated with the Entity.

Returns

Reference to StatusCondition object

Protected Functions

inline RTPS_DllAPI void set_instance_handle (const InstanceHandle_t &handle)

Setter for the Instance Handle.

Parameters

handle – 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.