#include <DomainParticipant.hpp>

Inheritance diagram for DomainParticipant< DELEGATE >:

Public Types
typedef dds::domain::DomainParticipantListener	Listener
typedef dds::core::cond::StatusCondition < DomainParticipant >	StatusCondition
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 tdds::core::Entity < DELEGATE >	BASE_T
Public Member Functions
template<typename T__ >
DomainParticipant &	operator= (const T__ &rhs)
	DomainParticipant (DELEGATE_T *p)
	DomainParticipant (const DELEGATE_REF_T &ref)
template<typename H__ >
	DomainParticipant (const H__ &h)
	DomainParticipant ()
	~DomainParticipant ()
StatusCondition	status_condition () 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)
dds::domain::DomainId	domain_id () const
void	assert_liveliness ()
bool	contains_entity (const dds::core::InstanceHandle &handle)
const dds::core::Time	current_time ()
dds::pub::Publisher	create_publisher ()
dds::pub::Publisher	create_publisher (const dds::pub::qos::PublisherQos &pub_qos, dds::pub::PublisherListener *pub_listener=NULL, const dds::core::status::StatusMask &event_mask=dds::core::status::StatusMask::all())
dds::pub::Publisher	create_publisher (const std::string &qos_library_name, const std::string &qos_profile_name, const dds::pub::PublisherListener *a_listener=NULL, const dds::core::status::StatusMask &mask=dds::core::status::StatusMask::all())
const dds::pub::qos::PublisherQos	default_publisher_qos () const
void	default_publisher_qos (const dds::pub::qos::PublisherQos &qos)
void	default_publisher_qos (const std::string &qos_library_name, const std::string &qos_profile_name)
dds::sub::Subscriber	create_subscriber ()
dds::sub::Subscriber	create_subscriber (const dds::sub::qos::SubscriberQos &qos, dds::sub::SubscriberListener *a_listener=NULL, const dds::core::status::StatusMask &a_mask=dds::core::status::StatusMask::all())
dds::sub::Subscriber	create_subscriber (const std::string &qos_library_name, const std::string &qos_profile_name, dds::sub::SubscriberListener *a_listener=NULL, const dds::core::status::StatusMask &a_mask=dds::core::status::StatusMask::all())
const dds::sub::qos::SubscriberQos	default_subscriber_qos () const
void	default_subscriber_qos (const dds::sub::qos::SubscriberQos &qos)
void	default_subscriber_qos (const std::string &qos_library_name, const std::string &qos_profile_name)
template<typename T >
dds::topic::Topic< T >	create_topic (const std::string &topic_name)
template<typename T >
dds::topic::Topic< T >	create_topic (const std::string &topic_name, const std::string &type_name_name)
template<typename T >
dds::topic::Topic< T >	create_topic (const std::string &topic_name, const std::string &type_name, const dds::topic::qos::TopicQos &topic_qos, dds::topic::TopicListener< T > *a_listener=NULL, const dds::core::status::StatusMask &mask=dds::core::status::StatusMask::all())
template<typename T >
dds::topic::Topic< T >	create_topic (const std::string &topic_name, const std::string &type_name_name, const std::string &qos_library_name, const std::string &qos_profile_name, dds::topic::TopicListener< T > *a_listener=NULL, const dds::core::status::StatusMask &mask=dds::core::status::StatusMask::all())
const dds::topic::qos::TopicQos	default_topic_qos () const
void	default_topic_qos (const dds::topic::qos::TopicQos &topic_qos)
void	default_topic_qos (const std::string &qos_library_name, const std::string &qos_profile_name)
template<typename T >
dds::topic::ContentFilteredTopic < T >	create_contentfilteredtopic (const std::string &name, const dds::topic::Topic< T > &related_topic, const std::string &filter_expression, const dds::core::StringSeq &expression_parameters)
template<typename T >
dds::topic::MultiTopic< T >	create_multitopic (const std::string &name, const std::string &type_name, const std::string &subscription_expression, const dds::core::StringSeq &expression_parameters)

Detailed Description

template<typename DELEGATE>
class tdds::domain::DomainParticipant< 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 59 of file DomainParticipant.hpp.

Member Typedef Documentation

typedef tdds::core::Entity< DELEGATE > BASE_T

Reimplemented from Entity< DELEGATE >.

Definition at line 67 of file DomainParticipant.hpp.

typedef ::dds::core::smart_ptr_traits< DELEGATE >::ref_type DELEGATE_REF_T

Reimplemented from Entity< DELEGATE >.

Definition at line 67 of file DomainParticipant.hpp.

typedef DELEGATE DELEGATE_T

Reimplemented from Entity< DELEGATE >.

Definition at line 67 of file DomainParticipant.hpp.

typedef ::dds::core::smart_ptr_traits< DELEGATE >::weak_ref_type DELEGATE_WEAK_REF_T

Reimplemented from Entity< DELEGATE >.

Definition at line 67 of file DomainParticipant.hpp.

typedef dds::domain::DomainParticipantListener Listener

Definition at line 61 of file DomainParticipant.hpp.

typedef dds::core::cond::StatusCondition<DomainParticipant> StatusCondition

Definition at line 64 of file DomainParticipant.hpp.

Constructor & Destructor Documentation

DomainParticipant ( DELEGATE_T * p ) [inline, explicit]

Definition at line 67 of file DomainParticipant.hpp.

DomainParticipant ( const DELEGATE_REF_T & ref ) [inline, explicit]

Definition at line 67 of file DomainParticipant.hpp.

DomainParticipant ( const H__ & h ) [inline]

Definition at line 67 of file DomainParticipant.hpp.

DomainParticipant ( ) [inline]

Definition at line 67 of file DomainParticipant.hpp.

~DomainParticipant ( ) [inline]

Definition at line 70 of file DomainParticipant.hpp.

Member Function Documentation

void assert_liveliness ( ) [inline]

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.

Definition at line 155 of file DomainParticipant.hpp.

bool contains_entity ( const dds::core::InstanceHandle & handle ) [inline]

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

Definition at line 175 of file DomainParticipant.hpp.

dds::topic::ContentFilteredTopic<T> create_contentfilteredtopic	(	const std::string &	name,
		const dds::topic::Topic< T > &	related_topic,
		const std::string &	filter_expression,
		const dds::core::StringSeq &	expression_parameters
	)

dds::topic::MultiTopic<T> create_multitopic	(	const std::string &	name,
		const std::string &	type_name,
		const std::string &	subscription_expression,
		const dds::core::StringSeq &	expression_parameters
	)

dds::pub::Publisher create_publisher ( )

This operation creates a Publisher with default QoS.

dds::pub::Publisher create_publisher	(	const std::string &	qos_library_name,
		const std::string &	qos_profile_name,
		const dds::pub::PublisherListener *	a_listener = `NULL`,
		const dds::core::status::StatusMask &	mask = `dds::core::status::StatusMask::all()`
	)

This operation creates a Publisher with the desired QoS policies and attaches to it the specified PublisherListener. If the specified QoS policies are not consistent, the operation will fail and an exception will be thrown.

dds::pub::Publisher create_publisher	(	const dds::pub::qos::PublisherQos &	pub_qos,
		dds::pub::PublisherListener *	pub_listener = `NULL`,
		const dds::core::status::StatusMask &	event_mask = `dds::core::status::StatusMask::all()`
	)

This operation creates a Publisher with the desired QoS policies and attaches to it the specified PublisherListener. If the specified QoS policies are not consistent, the operation will fail and an exception will be thrown.

dds::sub::Subscriber create_subscriber ( )

dds::sub::Subscriber create_subscriber	(	const dds::sub::qos::SubscriberQos &	qos,
		dds::sub::SubscriberListener *	a_listener = `NULL`,
		const dds::core::status::StatusMask &	a_mask = `dds::core::status::StatusMask::all()`
	)

dds::sub::Subscriber create_subscriber	(	const std::string &	qos_library_name,
		const std::string &	qos_profile_name,
		dds::sub::SubscriberListener *	a_listener = `NULL`,
		const dds::core::status::StatusMask &	a_mask = `dds::core::status::StatusMask::all()`
	)

dds::topic::Topic< T > create_topic ( const std::string & topic_name )

Definition at line 47 of file DomainParticipant.hpp.

dds::topic::Topic<T> create_topic	(	const std::string &	topic_name,
		const std::string &	type_name_name
	)

dds::topic::Topic< T > create_topic	(	const std::string &	topic_name,
		const std::string &	type_name,
		const dds::topic::qos::TopicQos &	topic_qos,
		dds::topic::TopicListener< T > *	a_listener = `NULL`,
		const dds::core::status::StatusMask &	mask = `dds::core::status::StatusMask::all()`
	)

Definition at line 29 of file DomainParticipant.hpp.

dds::topic::Topic<T> create_topic	(	const std::string &	topic_name,
		const std::string &	type_name_name,
		const std::string &	qos_library_name,
		const std::string &	qos_profile_name,
		dds::topic::TopicListener< T > *	a_listener = `NULL`,
		const dds::core::status::StatusMask &	mask = `dds::core::status::StatusMask::all()`
	)

const dds::core::Time current_time ( ) [inline]

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.

Definition at line 185 of file DomainParticipant.hpp.

void default_publisher_qos	(	const std::string &	qos_library_name,
		const std::string &	qos_profile_name
	)

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

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

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

void default_subscriber_qos	(	const std::string &	qos_library_name,
		const std::string &	qos_profile_name
	)

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

void default_topic_qos	(	const std::string &	qos_library_name,
		const std::string &	qos_profile_name
	)

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

void default_topic_qos ( const dds::topic::qos::TopicQos & topic_qos )

dds::domain::DomainId domain_id ( ) const [inline]

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

Definition at line 136 of file DomainParticipant.hpp.

Listener* listener ( ) const [inline]

Get the listener of this DomainParticipant

Definition at line 106 of file DomainParticipant.hpp.

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

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.

Definition at line 97 of file DomainParticipant.hpp.

DomainParticipant& operator= ( const T__ & rhs ) [inline]

Reimplemented from Entity< DELEGATE >.

Definition at line 67 of file DomainParticipant.hpp.

const dds::domain::qos::DomainParticipantQos qos ( ) const [inline]

Return the DomainParticipantQos setting for this instance.

Returns:: the qos setting.

Definition at line 118 of file DomainParticipant.hpp.

void qos ( const dds::domain::qos::DomainParticipantQos & the_qos ) [inline]

Definition at line 122 of file DomainParticipant.hpp.

StatusCondition status_condition ( ) const [inline]

This operation allows access to the StatusCondition (Section 7.1.2.1.9, "StatusCondition Class") associated with the Entity. The returned condition can then be added to a WaitSet (Section 7.1.2.1.6, WaitSet Class) so that the application can wait for specific status changes that affect the Entity.

Returns:: the status condition

Definition at line 84 of file DomainParticipant.hpp.

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

src/hpp/tdds/domain/DomainParticipant.hpp
src/hpp/dds/domain/DomainParticipant.hpp

DomainParticipant< DELEGATE > Class Template Reference

Public Types

Public Member Functions

Detailed Description

template<typename DELEGATE> class tdds::domain::DomainParticipant< DELEGATE >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

template<typename DELEGATE>
class tdds::domain::DomainParticipant< DELEGATE >