Class DTSupplementalTypeInfo

Class DTSupplementalTypeInfo provides information about a type that is not materialized as a C# class.

Inheritance

object

DTSupplementalTypeInfo

Implements

IEquatable<DTSupplementalTypeInfo>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: DTDLParser.Models

Assembly: DTDLParser.dll

Syntax

public class DTSupplementalTypeInfo : IEquatable<DTSupplementalTypeInfo>

Properties

ContextId

Gets the Dtmi of the context for the language extension in which this type is defined.

Declaration

public Dtmi ContextId { get; }

Property Value

Type	Description
Dtmi	The context identifier for the definition.

Remarks

If the supplemental type is intrinsic to the DTDL language instead of defined through an extension, the ID is the DTDL languge context.

ExtensionKind

Gets the kind of extension that this supplemental type represents.

Declaration

public DTExtensionKind ExtensionKind { get; }

Property Value

Type	Description
DTExtensionKind	The kind of extension.

Remarks

If the supplemental type is intrinsic to the DTDL language instead of defined through an extension, the kind is None.

IsAbstract

Gets a value indicating whether the supplemental type is abstract.

Declaration

public bool IsAbstract { get; }

Property Value

Type	Description
bool	True if the supplemental type is abstract.

ParentType

Gets the Dtmi of the supplemental type that is the parent of this type.

Declaration

public Dtmi ParentType { get; }

Property Value

Type	Description
Dtmi	The parent supplemental type's identifier.

Properties

Gets a collection of DTSupplementalPropertyInfo objects, each of which provides information about a property that can be applied to a DTDL element that has this supplemental type.

Declaration

public IReadOnlyDictionary<string, DTSupplementalPropertyInfo> Properties { get; }

Property Value

Type	Description
IReadOnlyDictionary<string, DTSupplementalPropertyInfo>	A dictionary that maps each string-valued property name to a DTSupplementalPropertyInfo object that describes the property with the given name.

Type

Gets the Dtmi that identifies the supplemental type.

Declaration

public Dtmi Type { get; }

Property Value

Type	Description
Dtmi	The supplemental type identifier.

Methods

Equals(DTSupplementalTypeInfo)

Determines whether the specified DTSupplementalTypeInfo is equal to the current object.

Declaration

public bool Equals(DTSupplementalTypeInfo other)

Parameters

Type	Name	Description
DTSupplementalTypeInfo	other	The other DTSupplementalTypeInfo to compare against.

Returns

Type	Description
bool	True if the specified object is equal to the current object; otherwise, false.

Operators

operator ==(DTSupplementalTypeInfo, DTSupplementalTypeInfo)

Determines whether two DTSupplementalTypeInfo objects are equal.

Declaration

public static bool operator ==(DTSupplementalTypeInfo x, DTSupplementalTypeInfo y)

Parameters

Type	Name	Description
DTSupplementalTypeInfo	x	One DTSupplementalTypeInfo object to compare.
DTSupplementalTypeInfo	y	Another DTSupplementalTypeInfo object to compare to the first.

Returns

Type	Description
bool	True if equal.

operator !=(DTSupplementalTypeInfo, DTSupplementalTypeInfo)

Determines whether two DTSupplementalTypeInfo objects are not equal.

Declaration

public static bool operator !=(DTSupplementalTypeInfo x, DTSupplementalTypeInfo y)

Parameters

Type	Name	Description
DTSupplementalTypeInfo	x	One DTSupplementalTypeInfo object to compare.
DTSupplementalTypeInfo	y	Another DTSupplementalTypeInfo object to compare to the first.

Returns

Type	Description
bool	True if not equal.

Implements

IEquatable<T>