#include <TDomainParticipant.hpp>

Inheritance diagram for dds::domain::TDomainParticipant< DELEGATE >:

Public Types
typedef dds::domain::DomainParticipantListener	Listener

Public Member Functions
	~TDomainParticipant ()

void	assert_liveliness ()

bool	contains_entity (const ::dds::core::InstanceHandle &handle)

dds::core::Time	current_time ()

dds::pub::qos::PublisherQos	default_publisher_qos () const

TDomainParticipant &	default_publisher_qos (const ::dds::pub::qos::PublisherQos &qos)

dds::sub::qos::SubscriberQos	default_subscriber_qos () const

TDomainParticipant &	default_subscriber_qos (const ::dds::sub::qos::SubscriberQos &qos)

dds::topic::qos::TopicQos	default_topic_qos () const

TDomainParticipant &	default_topic_qos (const dds::topic::qos::TopicQos &qos)

uint32_t	domain_id () const

void	listener (Listener *the_listener, const ::dds::core::status::StatusMask &event_mask)

Listener *	listener () const

const dds::domain::qos::DomainParticipantQos &	qos () const

void	qos (const dds::domain::qos::DomainParticipantQos &the_qos)

Public Member Functions inherited from dds::core::TEntity< DELEGATE >
	~TEntity ()

void	close ()

void	enable ()

const dds::core::InstanceHandle	instance_handle () const

void	retain ()

const dds::core::status::StatusMask	status_changes ()

Public Member Functions inherited from dds::core::Reference< DELEGATE >
	Reference (dds::core::null_type &)

	Reference (const Reference &ref)

template<typename D >
	Reference (const Reference< D > &ref)

	Reference (DELEGATE_T *p)

	~Reference ()

const DELEGATE_REF_T &	delegate () const

DELEGATE_REF_T &	delegate ()

bool	is_nil () const

	operator const DELEGATE_REF_T & () const

	operator DELEGATE_REF_T () const

	operator DELEGATE_REF_T & ()

template<typename R >
bool	operator!= (const R &ref) const

bool	operator!= (const null_type nil) const

DELEGATE *	operator-> ()

const DELEGATE *	operator-> () const

template<typename D >
Reference &	operator= (const Reference< D > &that)

template<typename R >
Reference &	operator= (const R &rhs)

Reference &	operator= (const null_type)

template<typename R >
bool	operator== (const R &ref) const

bool	operator== (const null_type) const

Static Public Member Functions
static dds::domain::qos::DomainParticipantQos	default_participant_qos ()

static void	default_participant_qos (const ::dds::domain::qos::DomainParticipantQos &qos)

Additional Inherited Members
Protected Attributes inherited from dds::core::Reference< DELEGATE >
DELEGATE_REF_T	impl_

Detailed Description

template<typename DELEGATE>
class dds::domain::TDomainParticipant< DELEGATE >

The DomainParticipant object plays several roles:

It represents the participation of the application on a communication plane that isolates applications running on the same set of physical computers from each other. A domain establishes a virtual network linking all applications that share the same domainId and isolating them from applications running on different domains. In this way, several independent distributed applications can coexist in the same physical network without interfering, or even being aware of each other.

Definition at line 61 of file TDomainParticipant.hpp.

Member Typedef Documentation

template<typename DELEGATE >

typedef dds::domain::DomainParticipantListener dds::domain::TDomainParticipant< DELEGATE >::Listener

Definition at line 63 of file TDomainParticipant.hpp.

Constructor & Destructor Documentation

template<typename DELEGATE >

dds::domain::TDomainParticipant< DELEGATE >::~TDomainParticipant ( )

Member Function Documentation

template<typename DELEGATE >

void dds::domain::TDomainParticipant< DELEGATE >::assert_liveliness ( )

This operation manually asserts the liveliness of the DataWriter. This is used in combination with the LIVELINESS QoS policy (see Section 7.1.3, Supported QoS, on page 96) to indicate to the Service that the entity remains active. This operation need only be used if the LIVELINESS setting is either MANUAL_BY_PARTICIPANT or MANUAL_BY_TOPIC. Otherwise, it has no effect.

Note Writing data via the write operation on a DataWriter asserts liveliness on the DataWriter itself and its DomainParticipant. Consequently the use of assert_liveliness is only needed if the application is not writing data regularly.

template<typename DELEGATE >

bool dds::domain::TDomainParticipant< DELEGATE >::contains_entity ( const ::dds::core::InstanceHandle & handle )

This operation checks whether or not the given a_handle represents an Entity that was created from the DomainParticipant. The containment applies recursively. That is, it applies both to entities (TopicDescription, Publisher, or Subscriber) created directly using the DomainParticipant as well as entities created using a contained Publisher, or Subscriber as the factory, and so forth.

Parameters

handle the instance handle for which the containement relationship has to be checked.

Returns: true if the handle belongs to an Entity belonging to this DomainParticipant

template<typename DELEGATE >

dds::core::Time dds::domain::TDomainParticipant< DELEGATE >::current_time ( )

This operation returns the current value of the time that the service uses to time-stamp data writes and to set the reception timestamp for the data updates it receives.

template<typename DELEGATE >

static dds::domain::qos::DomainParticipantQos dds::domain::TDomainParticipant< DELEGATE >::default_participant_qos ( )

static

template<typename DELEGATE >

static void dds::domain::TDomainParticipant< DELEGATE >::default_participant_qos ( const ::dds::domain::qos::DomainParticipantQos & qos )

static

template<typename DELEGATE >

dds::pub::qos::PublisherQos dds::domain::TDomainParticipant< DELEGATE >::default_publisher_qos ( ) const

template<typename DELEGATE >

TDomainParticipant& dds::domain::TDomainParticipant< DELEGATE >::default_publisher_qos ( const ::dds::pub::qos::PublisherQos & qos )

template<typename DELEGATE >

dds::sub::qos::SubscriberQos dds::domain::TDomainParticipant< DELEGATE >::default_subscriber_qos ( ) const

template<typename DELEGATE >

TDomainParticipant& dds::domain::TDomainParticipant< DELEGATE >::default_subscriber_qos ( const ::dds::sub::qos::SubscriberQos & qos )

template<typename DELEGATE >

dds::topic::qos::TopicQos dds::domain::TDomainParticipant< DELEGATE >::default_topic_qos ( ) const

template<typename DELEGATE >

TDomainParticipant& dds::domain::TDomainParticipant< DELEGATE >::default_topic_qos ( const dds::topic::qos::TopicQos & qos )

template<typename DELEGATE >

uint32_t dds::domain::TDomainParticipant< DELEGATE >::domain_id ( ) const

This operation retrieves the domain_id used to create the DomainParticipant. The domain_id identifies the DDS domain to which the DomainParticipant belongs. As described in the introduction to Section 7.1.2.2.1, DomainParticipant Class, on page 22 each DDS domain represents a separate data communication plane isolated from other domains.

Returns: the domain id

template<typename DELEGATE >

void dds::domain::TDomainParticipant< DELEGATE >::listener	(	Listener *	the_listener,
		const ::dds::core::status::StatusMask &	event_mask
	)

Register a listener with the <core>DomainParticipant. The notifications received by the listener depend on the status mask with which it was registered.

Parameters

listener	the listener
event_mask	the mask defining the events for which the listener will be notified.

template<typename DELEGATE >

Listener* dds::domain::TDomainParticipant< DELEGATE >::listener ( ) const

Get the listener of this DomainParticipant

template<typename DELEGATE >

const dds::domain::qos::DomainParticipantQos& dds::domain::TDomainParticipant< DELEGATE >::qos ( ) const

Return the DomainParticipantQos setting for this instance.

Returns: the qos setting.

template<typename DELEGATE >

void dds::domain::TDomainParticipant< DELEGATE >::qos ( const dds::domain::qos::DomainParticipantQos & the_qos )

The documentation for this class was generated from the following file:

src/hpp/dds/domain/TDomainParticipant.hpp

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

template<typename DELEGATE> class dds::domain::TDomainParticipant< DELEGATE >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

template<typename DELEGATE>
class dds::domain::TDomainParticipant< DELEGATE >