DDS.DomainId Struct Reference

PlaceHolder for a domain ID. More...

Collaboration diagram for DDS.DomainId:

Public Member Functions
	DomainId (int id)
	Create an DomainId based on an integer. More...
override bool	Equals (object obj)
	Test this DomainId is equal to the provided DomainId. More...
override int	GetHashCode ()
	Calculates hash of the DomainId. More...
long	ToInt32 ()
	Converts the DomainId to a long. More...
override string	ToString ()
	Converts DomainId to a string. More...
string	ToString (string format)
	Converts DomainId to a string with possible integer format. More...

Static Public Member Functions
static implicit	operator DomainId (int id)
	Implicit conversion from int to DomainId. More...
static implicit	operator int (DomainId id)
	Implicit conversion from DomainId to int. More...
static bool	operator!= (DomainId id1, DomainId id2)
	Test if two DomainIds are not equal. More...
static bool	operator== (DomainId id1, DomainId id2)
	Test if two DomainIds are equal. More...

Static Public Attributes
static readonly DomainId	Default = new DomainId(0x7fffffff)
	Representation of the default domain ID. More...
static readonly DomainId	Invalid = new DomainId(-1)
	Representation of an invalid domain ID. More...

Detailed Description

PlaceHolder for a domain ID.

This marshals as an int or 32-bit integer

Definition at line 516 of file DdsDcpsStructs.cs.

Constructor & Destructor Documentation

DomainId()

DDS.DomainId.DomainId ( int  id )

inline

Create an DomainId based on an integer.

Parameters

id	integer representation of the domainId.

Definition at line 541 of file DdsDcpsStructs.cs.

Member Function Documentation

Equals()

override bool DDS.DomainId.Equals ( object  obj )

inline

Test this DomainId is equal to the provided DomainId.

Parameters

obj	DomainId to compare.

Returns

true if the DomainId is equal.</returns

Definition at line 553 of file DdsDcpsStructs.cs.

GetHashCode()

override int DDS.DomainId.GetHashCode ( )

inline

Calculates hash of the DomainId.

Returns

Hash code.</returns

Definition at line 567 of file DdsDcpsStructs.cs.

operator DomainId()

static implicit DDS.DomainId.operator DomainId ( int  id )

inlinestatic

Implicit conversion from int to DomainId.

Parameters

id	integer to convert

Returns

new DomainId.</returns

Definition at line 616 of file DdsDcpsStructs.cs.

operator int()

static implicit DDS.DomainId.operator int ( DomainId  id )

inlinestatic

Implicit conversion from DomainId to int.

Parameters

id	DomainId to convert

Returns

DomainId as int.</returns

Definition at line 628 of file DdsDcpsStructs.cs.

operator!=()

static bool DDS.DomainId.operator!= ( DomainId  id1, DomainId  id2  )

inlinestatic

Test if two DomainIds are not equal.

Parameters

id1	DomainId to compare.
id2	DomainId to compare.

Returns

true if the DomainIds are not equal.</returns

Definition at line 604 of file DdsDcpsStructs.cs.

operator==()

static bool DDS.DomainId.operator== ( DomainId  id1, DomainId  id2  )

inlinestatic

Test if two DomainIds are equal.

Parameters

id1	DomainId to compare.
id2	DomainId to compare.

Returns

true if the DomainIds are equal.</returns

Definition at line 591 of file DdsDcpsStructs.cs.

ToInt32()

long DDS.DomainId.ToInt32 ( )

inline

Converts the DomainId to a long.

Returns

DomainId as a long.</returns

Definition at line 578 of file DdsDcpsStructs.cs.

ToString() [1/2]

override string DDS.DomainId.ToString ( )

inline

Converts DomainId to a string.

Returns

String containing the DomainId.</returns

Definition at line 639 of file DdsDcpsStructs.cs.

ToString() [2/2]

string DDS.DomainId.ToString ( string  format )

inline

Converts DomainId to a string with possible integer format.

Returns

String containing the DomainId.</returns

Definition at line 650 of file DdsDcpsStructs.cs.

Member Data Documentation

Default

readonly DomainId DDS.DomainId.Default = new DomainId(0x7fffffff)

static

Representation of the default domain ID.

This domain ID causes the creation of a DomainParticipant to use the domain ID that is provided within the configuration or 0 when no ID was provided (which is the default).

Definition at line 528 of file DdsDcpsStructs.cs.

Invalid

readonly DomainId DDS.DomainId.Invalid = new DomainId(-1)

static

Representation of an invalid domain ID.

Definition at line 533 of file DdsDcpsStructs.cs.

---

The documentation for this struct was generated from the following file:

• src/api/dcps/sacs/code/DDS/DdsDcpsStructs.cs