rti::domain Namespace Reference

<<extension>> Extensions to dds::domain More...

Classes
class	DomainParticipantConfigParams
	<<extension>> <<value-type>> Input paramaters for creating a participant from xml configuration. It allows modification of some of the properties of the entities defined in the configuration. More...

Functions
dds::core::InstanceHandleSeq	discovered_participants (dds::domain::DomainParticipant &participant)
	<<extension>> Retrieves the list of other participants discovered by this participant
dds::topic::ParticipantBuiltinTopicData	discovered_participant_data (dds::domain::DomainParticipant &participant, const dds::core::InstanceHandle &participant_handle)
	<<extension>> Retrieves the information about one participant discovered by this participant
dds::domain::DomainParticipant	find_participant_by_name (const std::string &participant_name)
	<<extension>> Locates an existing dds::domain::DomainParticipant by name.
template<typename ParticipantFwdIterator >
uint32_t	find_participants (ParticipantFwdIterator begin, uint32_t max_size)
	<<extension>> Retrieves all the participants created by the application up to a maximum number
template<typename ParticipantFwdIterator >
uint32_t	find_participants (ParticipantFwdIterator begin)
	<<extension>> Retrieves all the participants created by the application
void	register_type (dds::domain::DomainParticipant &participant, const std::string &name, const dds::core::xtypes::DynamicType &type, const rti::core::xtypes::DynamicDataTypeSerializationProperty &serialization_property=rti::core::xtypes::DynamicDataTypeSerializationProperty::DEFAULT)
	<<extension>> Registers a DynamicType with specific serialization properties
template<typename T >
void	register_type (const std::string &registered_type_name=dds::topic::topic_type_name< T >::value())
	<<extension>> Registers a User-Generated Type with RTI Connext. This function is used along with XML Application Creation.

Detailed Description

<<extension>> Extensions to dds::domain

Function Documentation

dds::core::InstanceHandleSeq rti::domain::discovered_participants

(

dds::domain::DomainParticipant &

participant

)

<<extension>> Retrieves the list of other participants discovered by this participant

This operation retrieves the list of dds::domain::DomainParticipant entities that have been discovered in the domain and that the application has not indicated should be "ignored" by means of the dds::domain::DomainParticipant::ignore(const dds::domain::DomainParticipant & participant, const dds::core::InstanceHandle & handle) operation.

Parameters

participant

The DomainParticipant where to look up the discovered participants

Returns

The list of InstanceHandles that can be passed to rti::domain::discovered_participant_data().

Exceptions

One	of the Standard Exceptions or dds::core::NotEnabledError

dds::topic::ParticipantBuiltinTopicData rti::domain::discovered_participant_data	(	dds::domain::DomainParticipant &	participant,
		const dds::core::InstanceHandle &	participant_handle
	)

<<extension>> Retrieves the information about one participant discovered by this participant

This operation retrieves information on a dds::domain::DomainParticipant that has been discovered on the network. The participant must be in the same domain as the participant on which this operation is invoked and must not have been "ignored" by means of the dds::domain::DomainParticipant::ignore(const dds::domain::DomainParticipant & participant, const dds::core::InstanceHandle & handle) operation.

The participant_handle must correspond to such a DomainParticipant. Otherwise, the operation will fail with dds::core::PreconditionNotMetError.

Use the operation rti::domain::discovered_participants() to find the dds::domain::DomainParticipant entities that are currently discovered.

Note: This operation does not retrieve the dds::topic::ParticipantBuiltinTopicData::property. This information is available through dds::sub::DataReaderListener::on_data_available() (if a reader listener is installed on the ParticipantBuiltinTopicDataDataReader).

MT Safety:

Unsafe. It is not safe to call this operation from multiple threads at the same time.

Parameters

participant	The DomainParticipant where to look up the information
participant_handle	<<in>> dds::core::InstanceHandle of dds::domain::DomainParticipant.

Returns

The participant information about participant_handle

Exceptions

One	of the Standard Exceptions, dds::core::PreconditionNotMetError or dds::core::NotEnabledError

See Also

dds::topic::ParticipantBuiltinTopicData

rti::domain::discovered_participants()

dds::domain::DomainParticipant rti::domain::find_participant_by_name

(

const std::string &

participant_name

)

<<extension>> Locates an existing dds::domain::DomainParticipant by name.

#include <rti/domain/find.hpp>

If no such DomainParticipant exists, the operation will return dds::core::null.

template<typename ParticipantFwdIterator >

uint32_t rti::domain::find_participants	(	ParticipantFwdIterator	begin,
		uint32_t	max_size
	)

<<extension>> Retrieves all the participants created by the application up to a maximum number

#include <rti/domain/find.hpp>

If no such DomainParticipant exists, the operation will return dds::core::null.

Template Parameters

ParticipantFwdIterator

A forward iterator whose value type is dds::domain::DomainParticipant

Parameters

begin	The iterator where to begin adding DomainParticipants.
max_size	The maximum number of elements to add

Returns

The number of elements added

template<typename ParticipantFwdIterator >

uint32_t rti::domain::find_participants

(

ParticipantFwdIterator

begin

)

<<extension>> Retrieves all the participants created by the application

#include <rti/domain/find.hpp>

Template Parameters

ParticipantFwdIterator

A forward iterator whose value type is dds::domain::DomainParticipant

Parameters

begin

The iterator where to begin adding DomainParticipants.

Returns

The number of elements added

void rti::domain::register_type	(	dds::domain::DomainParticipant &	participant,
		const std::string &	name,
		const dds::core::xtypes::DynamicType &	type,
		const rti::core::xtypes::DynamicDataTypeSerializationProperty &	serialization_property = rti::core::xtypes::DynamicDataTypeSerializationProperty::DEFAULT
	)

<<extension>> Registers a DynamicType with specific serialization properties

Typically you don't need to call this function, since this topic constructor takes care of that automatically. You do need to call this function before creating the topic if you want to change the default data-serialization property.

Calling this function also allows to change the registered name of the type, which by default is type.name().

Parameters

participant	The participant where to register this type
name	The name to use to register this type
type	The type definition
serialization_property	The data-serialization property

See Also

dds::core::xtypes::DynamicType

dds::core::xtypes::DynamicData

template<typename T >

void rti::domain::register_type

(

const std::string &

registered_type_name = dds::topic::topic_type_name<T>::value()

)

<<extension>> Registers a User-Generated Type with RTI Connext. This function is used along with XML Application Creation.

When using XML Application creation, you must use this function to register any user-generated types with RTI Connext before creating your system.

Typically you don't need to call this function, since the topic constructor takes care of that automatically.

Template Parameters

T	The user-generated type that is being registered

Parameters

registered_type_name

The name to use when registering the type. This is the name that will be used in your XML configuration file to refer to the type.

See Also

dds::domain::DomainParticipant::create_participant_from_config

XML Application Creation