Skip to main content

CkModelId

Namespace: Meshmakers.Octo.ConstructionKit.Contracts

Represents a versioned construction kit model id

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

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

Remarks:

We use a dash ("-") to separate the model id and the version. The version number of a model allows to manage versioning of models, it is allowed to have different elements (types, records, etc.) with the same name in different versions of a model.

Properties​

Name​

Returns the id of the model, e. g. "System"

public string Name { get; }

Property Value​

String

Version​

Returns the version of the model, e. g. "1.0.0"

public CkVersion Version { get; }

Property Value​

CkVersion

FullName​

Returns the full name of the model, e. g. "System-1.0.0"

public string FullName { get; }

Property Value​

String

SemanticVersionedFullName​

public string SemanticVersionedFullName { get; }

Property Value​

String

IsEmpty​

public bool IsEmpty { get; }

Property Value​

Boolean

Constructors​

CkModelId(String)​

Creates a new CkModelId from the given ckModelId.

public CkModelId(string ckModelId)

Parameters​

ckModelId String

CkModelId(String, String)​

Creates a new CkModelId from the given modelId and version.

public CkModelId(string modelId, string version)

Parameters​

modelId String

version String

CkModelId(String, CkVersion)​

Creates a new CkModelId from the given modelId and version.

public CkModelId(string modelId, CkVersion version)

Parameters​

modelId String

version CkVersion

Methods​

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

CompareTo(CkModelId)​

public int CompareTo(CkModelId other)

Parameters​

other CkModelId

Returns​

Int32

Equals(CkModelId)​

public bool Equals(CkModelId other)

Parameters​

other CkModelId

Returns​

Boolean

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

ToVersionRange()​

Converts to a version range

public CkModelIdVersionRange ToVersionRange()

Returns​

CkModelIdVersionRange