#include <Entity.hpp>
Inheritance diagram for Entity< DELEGATE >:
Public Types | |
| typedef DELEGATE | DELEGATE_T |
| typedef ::dds::core::smart_ptr_traits < DELEGATE >::ref_type | DELEGATE_REF_T |
| typedef ::dds::core::smart_ptr_traits < DELEGATE >::weak_ref_type | DELEGATE_WEAK_REF_T |
| typedef dds::core::Reference < DELEGATE > | BASE_T |
Public Member Functions | |
| template<typename T__ > | |
| Entity & | operator= (const T__ &rhs) |
| Entity (DELEGATE_T *p) | |
| Entity (const DELEGATE_REF_T &ref) | |
| template<typename H__ > | |
| Entity (const H__ &h) | |
| Entity () | |
| ~Entity () | |
| void | enable () |
| const dds::core::status::StatusMask | status_changes () |
| const dds::core::InstanceHandle | instance_handle () const |
| void | qos (const std::string &qos_library_name, const std::string &qos_profile_name) |
| void | close () |
| void | retain () |
Detailed Description
template<typename DELEGATE>
class tdds::core::Entity< DELEGATE >
This class is the abstract base class for all the DCPS objects that support QoS policies, a listener and a status condition. In the ISO C++ PSM each DDS entity behaves like a polymorphic reference in what it automatically manages its resource and it can be safely assigned up and down the DDS Entity type hierarchy.
Definition at line 39 of file Entity.hpp.
Member Typedef Documentation
| typedef dds::core::Reference< DELEGATE > BASE_T |
Reimplemented in DataWriter< T, DELEGATE >, DataReader< T, DELEGATE >, ContentFilteredTopic< T, DELEGATE >, MultiTopic< T, DELEGATE >, Topic< T, DELEGATE >, TopicDescription< T, DELEGATE >, DomainParticipant< DELEGATE >, Publisher< DELEGATE >, Subscriber< DELEGATE >, DataWriter< KeyedBytes >, DataWriter< T >, DataWriter< KeyedString >, DataWriter< dds::core::ByteSeq >, DataReader< KeyedBytes >, DataReader< T >, DataReader< KeyedString >, DataReader< dds::core::ByteSeq >, and Topic< T >.
Definition at line 41 of file Entity.hpp.
| typedef ::dds::core::smart_ptr_traits< DELEGATE >::ref_type DELEGATE_REF_T |
Reimplemented from Reference< DELEGATE >.
Reimplemented in DataWriter< T, DELEGATE >, DataReader< T, DELEGATE >, ContentFilteredTopic< T, DELEGATE >, MultiTopic< T, DELEGATE >, Topic< T, DELEGATE >, TopicDescription< T, DELEGATE >, DomainParticipant< DELEGATE >, Publisher< DELEGATE >, Subscriber< DELEGATE >, DataWriter< KeyedBytes >, DataWriter< T >, DataWriter< KeyedString >, DataWriter< dds::core::ByteSeq >, DataReader< KeyedBytes >, DataReader< T >, DataReader< KeyedString >, DataReader< dds::core::ByteSeq >, and Topic< T >.
Definition at line 41 of file Entity.hpp.
| typedef DELEGATE DELEGATE_T |
Reimplemented from Reference< DELEGATE >.
Reimplemented in DataWriter< T, DELEGATE >, DataReader< T, DELEGATE >, ContentFilteredTopic< T, DELEGATE >, MultiTopic< T, DELEGATE >, Topic< T, DELEGATE >, TopicDescription< T, DELEGATE >, DomainParticipant< DELEGATE >, Publisher< DELEGATE >, Subscriber< DELEGATE >, DataWriter< KeyedBytes >, DataWriter< T >, DataWriter< KeyedString >, DataWriter< dds::core::ByteSeq >, DataReader< KeyedBytes >, DataReader< T >, DataReader< KeyedString >, DataReader< dds::core::ByteSeq >, and Topic< T >.
Definition at line 41 of file Entity.hpp.
| typedef ::dds::core::smart_ptr_traits< DELEGATE >::weak_ref_type DELEGATE_WEAK_REF_T |
Reimplemented from Reference< DELEGATE >.
Reimplemented in DataWriter< T, DELEGATE >, DataReader< T, DELEGATE >, ContentFilteredTopic< T, DELEGATE >, MultiTopic< T, DELEGATE >, Topic< T, DELEGATE >, TopicDescription< T, DELEGATE >, DomainParticipant< DELEGATE >, Publisher< DELEGATE >, Subscriber< DELEGATE >, DataWriter< KeyedBytes >, DataWriter< T >, DataWriter< KeyedString >, DataWriter< dds::core::ByteSeq >, DataReader< KeyedBytes >, DataReader< T >, DataReader< KeyedString >, DataReader< dds::core::ByteSeq >, and Topic< T >.
Definition at line 41 of file Entity.hpp.
Constructor & Destructor Documentation
| Entity | ( | DELEGATE_T * | p | ) | [inline, explicit] |
Definition at line 41 of file Entity.hpp.
| Entity | ( | const DELEGATE_REF_T & | ref | ) | [inline, explicit] |
Definition at line 41 of file Entity.hpp.
| Entity | ( | const H__ & | h | ) | [inline] |
Definition at line 41 of file Entity.hpp.
| Entity | ( | ) | [inline] |
Definition at line 41 of file Entity.hpp.
| ~Entity | ( | ) | [inline] |
Definition at line 43 of file Entity.hpp.
Member Function Documentation
| void close | ( | ) | [inline] |
This method closes the entity and releases all resources associated with DDS, such as threads, sockets, buffers, etc. Any attempt to invoke methods on a closed entity will raise an exception.
Definition at line 108 of file Entity.hpp.
| void enable | ( | ) | [inline] |
This operation enables the Entity. Entity objects can be created either enabled or disabled. This is controlled by the value of the ENTITY_FACTORY Qos policy (Section 7.1.3.20, ENTITY_FACTORY) on the corresponding factory for the Entity. The default setting of ENTITY_FACTORY is such that, by default, it is not necessary to explicitly call enable on newly created entities (see Section 7.1.3.20, ENTITY_FACTORY). The enable operation is idempotent. Calling enable on an already enabled Entity does nor raise exceptions and has no effect.
Entities created from a factory that is disabled, are created disabled regardless of the setting of the ENTITY_FACTORY Qos policy. Calling enable on an Entity whose factory is not enabled will fail and return PRECONDITION_NOT_MET. If the ENTITY_FACTORY Qos policy has autoenable_created_entities set to TRUE, the enable operation on the factory will automatically enable all entities created from the factory. The Listeners associated with an entity are not called until the entity is enabled. Conditions associated with an entity that is not enabled are inactive, that is, have a trigger_value==FALSE (see Section 7.1.4.4, “Conditions and Wait-sets, on page 131).
Definition at line 69 of file Entity.hpp.
| const dds::core::InstanceHandle instance_handle | ( | ) | const [inline] |
This operation returns the InstanceHandle_t that represents the Entity.
Definition at line 96 of file Entity.hpp.
| Entity& operator= | ( | const T__ & | rhs | ) | [inline] |
Reimplemented in DataWriter< T, DELEGATE >, DataReader< T, DELEGATE >, ContentFilteredTopic< T, DELEGATE >, MultiTopic< T, DELEGATE >, Topic< T, DELEGATE >, TopicDescription< T, DELEGATE >, DomainParticipant< DELEGATE >, Publisher< DELEGATE >, Subscriber< DELEGATE >, DataWriter< KeyedBytes >, DataWriter< T >, DataWriter< KeyedString >, DataWriter< dds::core::ByteSeq >, DataReader< KeyedBytes >, DataReader< T >, DataReader< KeyedString >, DataReader< dds::core::ByteSeq >, and Topic< T >.
Definition at line 41 of file Entity.hpp.
| void qos | ( | const std::string & | qos_library_name, | |
| const std::string & | qos_profile_name | |||
| ) |
| void retain | ( | ) | [inline] |
Indicates that references to this object may go out of scope but that the application expects to look it up again later. Therefore, the Service must consider this object to be still in use and may not close it automatically.
Definition at line 118 of file Entity.hpp.
| const dds::core::status::StatusMask status_changes | ( | ) | [inline] |
This operation retrieves the list of communication statuses in the Entity that are triggered.That is, the list of statuses whose value has changed since the last time the application read the status. The precise definition of the triggered state of communication statuses is given in Section 7.1.4.2, Changes in Status, on page 126. When the entity is first created or if the entity is not enabled, all communication statuses are in the untriggered state so the list returned by the status_changes operation will be empty. The list of statuses returned by the status_changes operation refers to the statuses that are triggered on the Entity itself and does not include statuses that apply to contained entities.
- Returns:
- the status changes
Definition at line 88 of file Entity.hpp.
The documentation for this class was generated from the following file:
- src/hpp/tdds/core/Entity.hpp
