CkIdVersionRange<TKey>
Namespace: Meshmakers.Octo.ConstructionKit.Contracts
Represents a construction kit element id that is managed with a model id and a key
public record CkIdVersionRange<TKey> : IComparable<CkIdVersionRange<TKey>>, IEquatable<CkIdVersionRange<TKey>>
Type Parameters
TKey
The key type that is managed with a model id
Inheritance Object → CkIdVersionRange<TKey>
Implements IComparable<CkIdVersionRange<TKey>>, IEquatable<CkIdVersionRange<TKey>>
Properties
ModelId
Returns a the versioned range model id, e. g. e.g. "1.0.0" or "[1.0,)"
public CkModelIdVersionRange ModelId { get; }
Property Value
Key
Returns the element key
public TKey Key { get; }
Property Value
TKey
FullName
Returns the full name of the element, e.g. "System-1.0.0/Person-1.0.0"
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
CkIdVersionRange(CkModelIdVersionRange, TKey)
Creates a new CkId<TElementId> from the given modelId and key.
public CkIdVersionRange(CkModelIdVersionRange modelId, TKey key)
Parameters
modelId CkModelIdVersionRange
key TKey
CkIdVersionRange(String)
Creates a new CkId<TElementId> from the given ckId.
public CkIdVersionRange(string ckId)
Parameters
ckId String
Exceptions
Methods
Equals(CkIdVersionRange<TKey>)
public bool Equals(CkIdVersionRange<TKey> other)
Parameters
other CkIdVersionRange<TKey>
Returns
CompareTo(CkIdVersionRange<TKey>)
public int CompareTo(CkIdVersionRange<TKey> other)
Parameters
other CkIdVersionRange<TKey>
Returns
GetHashCode()
public int GetHashCode()
Returns
ToString()
Returns a string representation of the value.
public string ToString()
Returns
IsSatisfiedBy(CkId<TKey>)
Returns true if this id is satisfied by the given other id
public bool IsSatisfiedBy(CkId<TKey> other)
Parameters
other CkId<TKey>
Other id to check