Property Class Reference

Stores key-value string pairs that can configure certain Connext DDS parameters not exposed through QoS policies. It can also store and propagate through the discovery mechanism application-specific information associated with an Entity. More...

Inherits IEquatable< Property >.

Classes
struct	Entry
	The entry in the Property dictionary More...

Public Member Functions
Property	With (Action< PropertyDict.Builder > build)
	Creates a new Property with a set of changes specified in an Action More...
Dictionary< string, string >	ToStringDictionary ()
	Creates a string dictionary from the key-value pairs in this Property. The returned dictionary doesn't include the values of Entry.Propagate. More...
override bool	Equals (object other)
	Compares for equality More...
override int	GetHashCode ()
	Gets the hash code of Value. More...
bool	Equals (Property other)
	Compares for equality More...

Static Public Member Functions
static Property	FromDictionary (IDictionary< string, Entry > value)
	Creates a Property object with the keys and entries in a Dictionary More...
static Property	FromDictionary (IDictionary< string, string > dict, bool propagate=false)
	Creates a Property object with the keys and values in a Dictionary, with all entries having the same Entry.Propagate value. More...
static Property	FromDictionary (PropertyDict value)
	Creates a Property object with the key-value pairs in a Dictionary More...

Properties
PropertyDict	Value [get]
	Gets the dictionary containing the properties More...
static Property	Default [get]
	Singleton containing the default value, an empty dictionary More...

Detailed Description

Stores key-value string pairs that can configure certain Connext DDS parameters not exposed through QoS policies. It can also store and propagate through the discovery mechanism application-specific information associated with an Entity.

The full documentation is available in the C API: DDS_PropertyQosPolicy

Member Function Documentation

Equals() [1/2]

override bool Equals

(

object

other

)

Compares for equality

Equals() [2/2]

bool Equals

(

Property

other

)

Compares for equality

FromDictionary() [1/3]

static Property FromDictionary ( IDictionary< string, Entry >  value )

static

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

Parameters

value

The key-entry pairs

FromDictionary() [2/3]

static Property FromDictionary ( IDictionary< string, string >  dict, bool  propagate = false  )

static

Creates a Property object with the keys and values in a Dictionary, with all entries having the same Entry.Propagate value.

Parameters

dict	The key-value pairs
propagate	Whether to propagate all or none of the properties in the dictionary

FromDictionary() [3/3]

static Property FromDictionary ( PropertyDict  value )

static

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

Parameters

value

The key-value pairs

GetHashCode()

override int GetHashCode

(

)

Gets the hash code of Value.

ToStringDictionary()

Dictionary<string, string> ToStringDictionary

(

)

Creates a string dictionary from the key-value pairs in this Property. The returned dictionary doesn't include the values of Entry.Propagate.

With()

Property With

(

Action< PropertyDict.Builder >

build

)

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

Parameters

build

An action (typically a lambda function) that receives a dictionary builder containing the current properties and allows adding, removing, or replacing.

Returns

A new Property with the changes applied by the Action

Property Documentation

Default

Property Default

staticget

Singleton containing the default value, an empty dictionary

Value

PropertyDict Value

get

Gets the dictionary containing the properties