Skip to main content

CkAssociationRoleId

Namespace: Meshmakers.Octo.ConstructionKit.Contracts

Represents a versioned construction kit association id

public record CkAssociationRoleId : IComparable<CkAssociationRoleId>, ICkElementId, IConvertible, IEquatable<CkAssociationRoleId>

Inheritance Object → CkAssociationRoleId
Implements IComparable<CkAssociationRoleId>, ICkElementId, IConvertible, IEquatable<CkAssociationRoleId>

Properties​

RoleId​

Defines the name of the association, e.g. "ParentChild"

public string RoleId { get; }

Property Value​

String

Version​

Returns the version of the association role, e.g. "1.0.0"

public uint Version { get; }

Property Value​

UInt32

FullName​

Returns the full name of the association role, e.g. "ParentChild-1"

public string FullName { get; }

Property Value​

String

SemanticVersionedFullName​

public string SemanticVersionedFullName { get; }

Property Value​

String

IsEmpty​

public bool IsEmpty { get; }

Property Value​

Boolean

Constructors​

CkAssociationRoleId(String)​

Creates a new CkAssociationRoleId from the given roleId.

public CkAssociationRoleId(string roleId)

Parameters​

roleId String

Exceptions​

ArgumentOutOfRangeException

CkAssociationRoleId(String, UInt32)​

Creates a new CkAssociationRoleId from the given roleId and associationRoleVersion.

public CkAssociationRoleId(string roleId, uint associationRoleVersion)

Parameters​

roleId String

associationRoleVersion UInt32

Methods​

CompareTo(CkAssociationRoleId)​

public int CompareTo(CkAssociationRoleId other)

Parameters​

other CkAssociationRoleId

Returns​

Int32

Equals(CkAssociationRoleId)​

public bool Equals(CkAssociationRoleId other)

Parameters​

other CkAssociationRoleId

Returns​

Boolean

GetTypeCode()​

public TypeCode GetTypeCode()

Returns​

TypeCode

ToBoolean(IFormatProvider)​

public bool ToBoolean(IFormatProvider provider)

Parameters​

provider IFormatProvider

Returns​

Boolean

ToByte(IFormatProvider)​

public byte ToByte(IFormatProvider provider)

Parameters​

provider IFormatProvider

Returns​

Byte

ToChar(IFormatProvider)​

public char ToChar(IFormatProvider provider)

Parameters​

provider IFormatProvider

Returns​

Char

ToDateTime(IFormatProvider)​

public DateTime ToDateTime(IFormatProvider provider)

Parameters​

provider IFormatProvider

Returns​

DateTime

ToDecimal(IFormatProvider)​

public decimal ToDecimal(IFormatProvider provider)

Parameters​

provider IFormatProvider

Returns​

Decimal

ToDouble(IFormatProvider)​

public double ToDouble(IFormatProvider provider)

Parameters​

provider IFormatProvider

Returns​

Double

ToInt16(IFormatProvider)​

public short ToInt16(IFormatProvider provider)

Parameters​

provider IFormatProvider

Returns​

Int16

ToInt32(IFormatProvider)​

public int ToInt32(IFormatProvider provider)

Parameters​

provider IFormatProvider

Returns​

Int32

ToInt64(IFormatProvider)​

public long ToInt64(IFormatProvider provider)

Parameters​

provider IFormatProvider

Returns​

Int64

ToSByte(IFormatProvider)​

public sbyte ToSByte(IFormatProvider provider)

Parameters​

provider IFormatProvider

Returns​

SByte

ToSingle(IFormatProvider)​

public float ToSingle(IFormatProvider provider)

Parameters​

provider IFormatProvider

Returns​

Single

ToString(IFormatProvider)​

public string ToString(IFormatProvider provider)

Parameters​

provider IFormatProvider

Returns​

String

ToType(Type, IFormatProvider)​

public object ToType(Type conversionType, IFormatProvider provider)

Parameters​

conversionType Type

provider IFormatProvider

Returns​

Object

ToUInt16(IFormatProvider)​

public ushort ToUInt16(IFormatProvider provider)

Parameters​

provider IFormatProvider

Returns​

UInt16

ToUInt32(IFormatProvider)​

public uint ToUInt32(IFormatProvider provider)

Parameters​

provider IFormatProvider

Returns​

UInt32

ToUInt64(IFormatProvider)​

public ulong ToUInt64(IFormatProvider provider)

Parameters​

provider IFormatProvider

Returns​

UInt64

ToString()​

Returns a string representation of the value.

public string ToString()

Returns​

String
A string representation of the value.

GetHashCode()​

public int GetHashCode()

Returns​

Int32