DDS.InstanceHandle Struct Reference

Class to hold the handle associated with in sample instance. More...

Collaboration diagram for DDS.InstanceHandle:

Public Member Functions
	InstanceHandle (long handleVal)
	Constructor to create an instance handle that represents the long. More...
override bool	Equals (object obj)
	Test this InstanceHandle is equal to the provided InstanceHandle. More...
override int	GetHashCode ()
	Calculates hash of the InstanceHandle. More...
long	ToInt64 ()
	Converts the InstanceHandle into an long. More...
override string	ToString ()
	Converts InstanceHandle to a string. More...
string	ToString (string format)
	Converts InstanceHandle to a string with possible integer format. More...

Static Public Member Functions
static implicit	operator InstanceHandle (long handleVal)
	Implicit conversion from long to InstanceHandle. More...
static implicit	operator long (InstanceHandle handle)
	Implicit conversion from InstanceHandle to long. More...
static bool	operator!= (InstanceHandle handle1, InstanceHandle handle2)
	Test if two InstanceHandles are not equal. More...
static bool	operator== (InstanceHandle handle1, InstanceHandle handle2)
	Test if two InstanceHandles are equal. More...

Static Public Attributes
static readonly InstanceHandle	Nil = new InstanceHandle(0)
	Create an nil instance handle. More...

Detailed Description

Class to hold the handle associated with in sample instance.

Definition at line 631 of file DdsDcpsStructs.cs.

Constructor & Destructor Documentation

InstanceHandle()

DDS.InstanceHandle.InstanceHandle ( long  handleVal )

inline

Constructor to create an instance handle that represents the long.

Parameters

handleVal

handleVal long to convert into an InstanceHandle.

Definition at line 646 of file DdsDcpsStructs.cs.

Member Function Documentation

Equals()

override bool DDS.InstanceHandle.Equals ( object  obj )

inline

Test this InstanceHandle is equal to the provided InstanceHandle.

Parameters

obj	InstanceHandle to compare.

Returns

true if the InstanceHandle is equal.</returns

Definition at line 658 of file DdsDcpsStructs.cs.

GetHashCode()

override int DDS.InstanceHandle.GetHashCode ( )

inline

Calculates hash of the InstanceHandle.

Returns

Hash code.</returns

Definition at line 672 of file DdsDcpsStructs.cs.

operator InstanceHandle()

static implicit DDS.InstanceHandle.operator InstanceHandle ( long  handleVal )

inlinestatic

Implicit conversion from long to InstanceHandle.

Returns

long as InstanceHandle.</returns

Definition at line 720 of file DdsDcpsStructs.cs.

operator long()

static implicit DDS.InstanceHandle.operator long ( InstanceHandle  handle )

inlinestatic

Implicit conversion from InstanceHandle to long.

Returns

InstanceHandle as long.</returns

Definition at line 731 of file DdsDcpsStructs.cs.

operator!=()

static bool DDS.InstanceHandle.operator!= ( InstanceHandle  handle1, InstanceHandle  handle2  )

inlinestatic

Test if two InstanceHandles are not equal.

Parameters

handle1	InstanceHandle to compare.
handle2	InstanceHandle to compare.

Returns

true if the InstanceHandles are not equal.</returns

Definition at line 709 of file DdsDcpsStructs.cs.

operator==()

static bool DDS.InstanceHandle.operator== ( InstanceHandle  handle1, InstanceHandle  handle2  )

inlinestatic

Test if two InstanceHandles are equal.

Parameters

handle1	InstanceHandle to compare.
handle2	InstanceHandle to compare.

Returns

true if the InstanceHandles are equal.</returns

Definition at line 696 of file DdsDcpsStructs.cs.

ToInt64()

long DDS.InstanceHandle.ToInt64 ( )

inline

Converts the InstanceHandle into an long.

Returns

InstanceHandle as long.</returns

Definition at line 683 of file DdsDcpsStructs.cs.

ToString() [1/2]

override string DDS.InstanceHandle.ToString ( )

inline

Converts InstanceHandle to a string.

Returns

String containing the InstanceHandle.</returns

Definition at line 742 of file DdsDcpsStructs.cs.

ToString() [2/2]

string DDS.InstanceHandle.ToString ( string  format )

inline

Converts InstanceHandle to a string with possible integer format.

Returns

String containing the InstanceHandle.</returns

Definition at line 753 of file DdsDcpsStructs.cs.

Member Data Documentation

Nil

readonly InstanceHandle DDS.InstanceHandle.Nil = new InstanceHandle(0)

static

Create an nil instance handle.

Definition at line 638 of file DdsDcpsStructs.cs.

---

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

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