RTI Connext Modern C++ API  Version 5.3.1
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
rti::core::policy::EntityName Class Reference

<<extension>> Assigns a name to a DomainParticipant, Publisher, Subscriber, DataWriter or DataReader. More...

#include <rti/core/policy/CorePolicy.hpp>

Public Member Functions

 EntityName ()
 Creates the default policy (no name)
 
 EntityName (const std::string &the_name)
 Creates an instance that specifies an entity name.
 
EntityNamename (const rti::core::optional_value< std::string > &the_name)
 Sets the entity name.
 
EntityNamename (const char *the_name)
 Sets the entity name.
 
rti::core::optional_value
< std::string > 
name () const
 Gets the entity name.
 
EntityNamerole_name (const rti::core::optional_value< std::string > &the_name)
 Specifies an entity role name.
 
EntityNamerole_name (const char *the_name)
 Sets the role name.
 
rti::core::optional_value
< std::string > 
role_name () const
 Gets the entity role name.
 

Detailed Description

<<extension>> Assigns a name to a DomainParticipant, Publisher, Subscriber, DataWriter or DataReader.

Except for the Publisher and Subscriber, these names are visible during the discovery process and in RTI tools to help you visualize and debug your system.

Entity:
dds::domain::DomainParticipant, dds::sub::Subscriber, dds::pub::Publisher, dds::sub::DataReader, dds::pub::DataWriter
Properties:
RxO = NO;
Changeable = UNTIL ENABLE

Usage

The name and role name can only be 255 characters in length.

Constructor & Destructor Documentation

rti::core::policy::EntityName::EntityName ( )
inline

Creates the default policy (no name)

rti::core::policy::EntityName::EntityName ( const std::string &  the_name)
inlineexplicit

Creates an instance that specifies an entity name.

Member Function Documentation

EntityName& rti::core::policy::EntityName::name ( const rti::core::optional_value< std::string > &  the_name)

Sets the entity name.

Parameters
the_nameAn optional string. An unset value indicates that this entity should have no name. A set value will set a name. The string can't exceed 255 characters.

[default] Unset (no name)

EntityName& rti::core::policy::EntityName::name ( const char *  the_name)

Sets the entity name.

Parameters
the_nameCan't exceed 255 characters.
rti::core::optional_value<std::string> rti::core::policy::EntityName::name ( ) const

Gets the entity name.

Returns
An optional string. An unset value indicates that the entity has not been assigned a name.
EntityName& rti::core::policy::EntityName::role_name ( const rti::core::optional_value< std::string > &  the_name)

Specifies an entity role name.

With Durable Subscriptions this name is used to specify to which Durable Subscription the DataReader belongs.

With Collaborative DataWriters this name is used to specify to which endpoint group the DataWriter belongs.

Parameters
the_nameAn optional string. An unset value indicates that the Entity will have no role name (the default). The string can't exceed 255 characters.

[default] Unset (no role name)

EntityName& rti::core::policy::EntityName::role_name ( const char *  the_name)
rti::core::optional_value<std::string> rti::core::policy::EntityName::role_name ( ) const

Gets the entity role name.

Returns
An optional string. An unset value indicates that the entity has not been assigned a role name.

RTI Connext Modern C++ API Version 5.3.1 Copyright © Mon Feb 19 2018 Real-Time Innovations, Inc