ClusterId

Sansar.Simulation.ClusterId

ClusterId Struct

Encapsulates an Cluster Id.

Syntax

[Sansar.Script.Interface]
public struct ClusterId

Remarks

 

Requirements

Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0

Members

See Also: Inherited members from ValueType.

Public Fields

static readonly
Invalid ClusterId . The invalid id object.

Public Methods

override
Equals (object) : bool
Value comparison for ClusterId.
override
GetHashCode () : int
Retrieves the hash code for this instance.
override
ToString () : string
Converts the id to a hexadecimal string representation.

Public Operators

static
Equality (ClusterId, ClusterId) ClusterId equality operator.
static
Inequality (ClusterId, ClusterId) ClusterId inequality operator.
static
Conversion to Sansar.Simulation.ClusterId (Implicit) Internal explicit conversion from a uint.

Member Details

Equals Method

Value comparison for ClusterId.

Syntax

[Sansar.Script.Interface]
public override bool Equals (object obj)

Parameters

obj
The object to compare.

Returns

true if the argument is an ClusterId and has the same value.

Remarks

 

Requirements

Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0

GetHashCode Method

Retrieves the hash code for this instance.

Syntax

[Sansar.Script.Interface]
public override int GetHashCode ()

Returns

The hash code for this instance.

Remarks

 

Requirements

Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0

Invalid Field

The invalid id object.

Syntax

[Sansar.Script.Interface]
public static readonly ClusterId Invalid

Remarks

 

Requirements

Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0

op_Equality Method

ClusterId equality operator.

Syntax

[Sansar.Script.Interface]
public static bool operator== (ClusterId a, ClusterId b)

Parameters

a
First ClusterId to compare.
b
Second ClusterId to compare.

Returns

true if the ClusterIds have the same value.

Remarks

 

Requirements

Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0

Conversion Method

Internal explicit conversion from a uint.

Syntax

public static implicit operator ClusterId (uint id)

Parameters

id
A uint representation of an ClusterId

Returns

Remarks

 

Requirements

Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0

op_Inequality Method

ClusterId inequality operator.

Syntax

[Sansar.Script.Interface]
public static bool operator!= (ClusterId a, ClusterId b)

Parameters

a
First ClusterId to compare.
b
Second ClusterId to compare.

Returns

true if the ClusterIds have a different value.

Remarks

 

Requirements

Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0

ToString Method

Converts the id to a hexadecimal string representation.

Syntax

[Sansar.Script.Interface]
public override string ToString ()

Returns

The hexadecimal string representation.

Remarks

 

Requirements

Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0


Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

0 Comments

Article is closed for comments.