RTI Connext C# API  6.1.2
DataTags Class Reference

Stores name-value (string) pairs that can be used to determine access permissions. More...

Inherits IEquatable< DataTags >.

Public Member Functions

DataTags With (Action< ImmutableDictionary< string, string >.Builder > build)
 Creates a new DataTags 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 of Value. More...
 
bool Equals (DataTags other)
 Compares for equality More...
 

Static Public Member Functions

static DataTags FromDictionary (IDictionary< string, string > value)
 Creates a DataTags object with the keys and entries in a Dictionary More...
 
static DataTags FromDictionary (ImmutableDictionary< string, string > value)
 Creates a DataTags object with the key-value pairs in a Dictionary More...
 

Properties

ImmutableDictionary< string, string > Value [get]
 Gets the dictionary containing the properties More...
 
static DataTags Default [get]
 Singleton containing the default value, an empty dictionary More...
 

Detailed Description

Stores name-value (string) pairs that can be used to determine access permissions.

The full documentation is available in the C API: DDS_DataTags

Member Function Documentation

◆ Equals() [1/2]

bool Equals ( DataTags  other)

Compares for equality

◆ Equals() [2/2]

override bool Equals ( object  other)

Compares for equality

◆ FromDictionary() [1/2]

static DataTags FromDictionary ( IDictionary< string, string >  value)
static

Creates a DataTags object with the keys and entries in a Dictionary

Parameters
valueThe key-entry pairs

◆ FromDictionary() [2/2]

static DataTags FromDictionary ( ImmutableDictionary< string, string >  value)
static

Creates a DataTags object with the key-value pairs in a Dictionary

Parameters
valueThe key-value pairs

◆ GetHashCode()

override int GetHashCode ( )

Gets the hash code of Value.

◆ With()

DataTags With ( Action< ImmutableDictionary< string, string >.Builder >  build)

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

Parameters
buildAn action (typically a lambda function) that receives a dictionary builder containing the current properties and allows adding, removing, or replacing.
Returns
A new DataTags with the changes applied by the Action

Property Documentation

◆ Default

DataTags Default
staticget

Singleton containing the default value, an empty dictionary

◆ Value

ImmutableDictionary<string, string> Value
get

Gets the dictionary containing the properties