EntityName Class Reference

Assigns a name and a role name to a Domain.DomainParticipant, Publication.Publisher, Subscription.Subscriber, Publication.DataWriter<T> or Subscription.DataReader<T>. Except for Publication.Publisher and Subscription.Subscriber, these names will be visible during the discovery process and in RTI tools to help you visualize and debug your system. More...

Inherits IEquatable< EntityName >.

Public Member Functions
	EntityName ([AllowNull] string name, [AllowNull] string roleName=null)
	Creates a new EntityName policy More...
EntityName	With (Action< EntityNameBuilder > build)
	Creates a new EntityName with a set of changes specified in an Action More...
override bool	Equals (object other)
	Compares for equality More...
override int	GetHashCode ()
	Gets the hash code More...
bool	Equals (EntityName other)
	Compares for equality More...
override string	ToString ()
	Returns a string representation More...

Static Public Member Functions
static implicit	operator EntityName (string name)
	Implicit conversion from a string to an EntityName (with null RoleName) More...

Properties
string	Name [get]
	Gets the value of Name More...
string	RoleName [get]
	Gets the value of RoleName More...
static EntityName	Default [get]
	Singleton containing the default value of a EntityName More...

Detailed Description

Assigns a name and a role name to a Domain.DomainParticipant, Publication.Publisher, Subscription.Subscriber, Publication.DataWriter<T> or Subscription.DataReader<T>. Except for Publication.Publisher and Subscription.Subscriber, these names will be visible during the discovery process and in RTI tools to help you visualize and debug your system.

The full documentation is available in the C API: DDS_EntityNameQosPolicy

Constructor & Destructor Documentation

EntityName()

EntityName	(	[AllowNull] string	name,
		[AllowNull] string	roleName = null
	)

Creates a new EntityName policy

Parameters

name	The entity name (can be null)
roleName	The role name (can be null)

Member Function Documentation

Equals() [1/2]

bool Equals

(

EntityName

other

)

Compares for equality

Equals() [2/2]

override bool Equals

(

object

other

)

Compares for equality

GetHashCode()

override int GetHashCode

(

)

Gets the hash code

operator EntityName()

static implicit operator EntityName ( string  name )

static

Implicit conversion from a string to an EntityName (with null RoleName)

Parameters

name	The entity name

ToString()

override string ToString

(

)

Returns a string representation

With()

EntityName With

(

Action< EntityNameBuilder >

build

)

Creates a new EntityName with a set of changes specified in an Action

Parameters

build

An Action (typically a lambda function) that receives a modifiable object with the values of this EntityName.

Returns

A new EntityName with the changes applied by the Action

Property Documentation

Default

EntityName Default

staticget

Singleton containing the default value of a EntityName

Name

string Name

get

Gets the value of Name

The full documentation is available in the C API: DDS_EntityNameQosPolicy::name

RoleName

string RoleName

get

Gets the value of RoleName

The full documentation is available in the C API: DDS_EntityNameQosPolicy::role_name