ID

Public Struct

An ID is used to uniquely identify a specific item.

Namespace: GH_IO.Serialization

Assembly: GH_IO (in GH_IO.dll)

Syntax

public struct ID : IComparable<ID>, IEquatable<ID>

The ID type exposes the following members.

Constructors

Name

Description

---

Public Method

ID(String)

Constuctor for IDs.

---

Public Method

ID(String, Int32)

Constructor for IDs.

---

Properties

Name

Description

---

Public Property

Hash

Gets the hash code.

---

Public Property

HasIndex

Gets whether the index has been set.

---

Public Property

HasName

Gets whether the name has been set. Every valid ID must have a name.

---

Public Property

Index

Gets the index of this ID, if there is no valid index then -1 is returned.

---

Public Property

Name

Gets the name of this ID.

---

Methods

Name

Description

---

Public Method

CompareTo

Compares this ID to another ID.

---

Public Method

Equals

Determines if two IDs are equal.

---

Public Method

GetHashCode

Gets the hash code.

(Overrides ValueType.GetHashCode..)

---

Public Method

ToString

Gets a string representation for this ID.

(Overrides ValueType.ToString..)

---