RTI Connext Modern C++ API
Version 5.3.1
|
<<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. | |
EntityName & | name (const rti::core::optional_value< std::string > &the_name) |
Sets the entity name. | |
EntityName & | name (const char *the_name) |
Sets the entity name. | |
rti::core::optional_value < std::string > | name () const |
Gets the entity name. | |
EntityName & | role_name (const rti::core::optional_value< std::string > &the_name) |
Specifies an entity role name. | |
EntityName & | role_name (const char *the_name) |
Sets the role name. | |
rti::core::optional_value < std::string > | role_name () const |
Gets the entity role name. | |
<<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.
The name and role name can only be 255 characters in length.
|
inline |
Creates the default policy (no name)
|
inlineexplicit |
Creates an instance that specifies an entity name.
EntityName& rti::core::policy::EntityName::name | ( | const rti::core::optional_value< std::string > & | the_name | ) |
Sets the entity name.
the_name | An 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.
the_name | Can't exceed 255 characters. |
rti::core::optional_value<std::string> rti::core::policy::EntityName::name | ( | ) | const |
Gets the entity 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.
the_name | An 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 | ) |
Sets the role name.
rti::core::optional_value<std::string> rti::core::policy::EntityName::role_name | ( | ) | const |
Gets the entity role name.