RTI Connext Modern C++ API
Version 5.2.3
|
<<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::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 ®istered_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. | |
<<extension>> Extensions to dds::domain
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.
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.
ParticipantFwdIterator | A forward iterator whose value type is dds::domain::DomainParticipant |
begin | The iterator where to begin adding DomainParticipants. |
max_size | The maximum number of elements to add |
uint32_t rti::domain::find_participants | ( | ParticipantFwdIterator | begin | ) |
<<extension>> Retrieves all the participants created by the application
#include
<rti/domain/find.hpp>
ParticipantFwdIterator | A forward iterator whose value type is dds::domain::DomainParticipant |
begin | The iterator where to begin adding DomainParticipants. |
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()
.
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 |
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.
T | The user-generated type that is being registered |
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. |