CkId<TElementId>
Namespace: Meshmakers.Octo.ConstructionKit.Contracts
Represents a versioned construction kit element id
public record CkId<TElementId> : IComparable<CkId<TElementId>>, IEquatable<CkId<TElementId>>
Type Parameters
TElementId
The key type that is managed with a model id
Inheritance Object → CkId<TElementId>
Implements IComparable<CkId<TElementId>>, IEquatable<CkId<TElementId>>
Properties
ModelId
Returns the versioned model id, e. g. "System-1.0.0"
public CkModelId ModelId { get; }
Property Value
ElementId
Returns the element key
public TElementId ElementId { get; }
Property Value
TElementId
FullName
Returns the full name of the element, e.g. "System-1.0.0/Person-1"
public string FullName { get; }
Property Value
SemanticVersionedFullName
Returns the semantic versioned name of the element, e.g. "System/Person-2"
public string SemanticVersionedFullName { get; }
Property Value
IsEmpty
Returns true if the model id and key is empty
public bool IsEmpty { get; }
Property Value
Constructors
CkId(CkModelId, TElementId)
Creates a new CkId<TElementId> from the given modelId and elementId.
public CkId(CkModelId modelId, TElementId elementId)
Parameters
modelId CkModelId
elementId TElementId
CkId(String)
Creates a new CkId<TElementId> from the given ckId.
public CkId(string ckId)
Parameters
ckId String
Exceptions
Methods
Equals(CkId<TElementId>)
public bool Equals(CkId<TElementId> other)
Parameters
other CkId<TElementId>
Returns
Equals(RtCkId<TElementId>)
Indicates whether the current object is equal to another object of the same type, ignoring the model version.
public bool Equals(RtCkId<TElementId> other)
Parameters
other RtCkId<TElementId>
The object to compare with this object.
Returns
Boolean
>true if the current object is equal to the other parameter; otherwise, false.
CompareTo(CkId<TElementId>)
public int CompareTo(CkId<TElementId> other)
Parameters
other CkId<TElementId>
Returns
GetHashCode()
public int GetHashCode()
Returns
ToString()
Returns a string representation of the value.
public string ToString()
Returns
ToRtCkId()
Gets the runtime construction kit id
public RtCkId<TElementId> ToRtCkId()
Returns
RtCkId<TElementId>
The runtime construction kit id