Class DTInterfaceInfo

Class DTInterfaceInfo corresponds to an element of type Interface in a DTDL model.

Inheritance

object

DTEntityInfo

DTInterfaceInfo

Implements

IEquatable<DTEntityInfo>

IRootable

IEquatable<DTInterfaceInfo>

Inherited Members

DTEntityInfo.EntityKind

DTEntityInfo.ChildOf

DTEntityInfo.DefinedIn

DTEntityInfo.Id

DTEntityInfo.UndefinedProperties

DTEntityInfo.LanguageMajorVersion

DTEntityInfo.UndefinedTypes

DTEntityInfo.Description

DTEntityInfo.DisplayName

DTEntityInfo.Comment

DTEntityInfo.ValidateInstance(JsonElement)

DTEntityInfo.ValidateInstance(string)

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 DTInterfaceInfo : DTEntityInfo, IEquatable<DTEntityInfo>, IRootable, IEquatable<DTInterfaceInfo>

Properties

ClassId

Get the DTMI that identifies type Interface in the version of DTDL used to define this element.

Declaration

public override Dtmi ClassId { get; }

Property Value

Type	Description
Dtmi	The DTMI for the DTDL type Interface.

Overrides

DTEntityInfo.ClassId

Commands

Gets a subset of values from the 'contents' property of the corresponding DTDL element, for which the values have type Command.

Declaration

public IReadOnlyDictionary<string, DTCommandInfo> Commands { get; }

Property Value

Type	Description
IReadOnlyDictionary<string, DTCommandInfo>	The Command values from the 'contents' property of the DTDL element.

Components

Gets a subset of values from the 'contents' property of the corresponding DTDL element, for which the values have type Component.

Declaration

public IReadOnlyDictionary<string, DTComponentInfo> Components { get; }

Property Value

Type	Description
IReadOnlyDictionary<string, DTComponentInfo>	The Component values from the 'contents' property of the DTDL element.

Contents

Gets the values of the 'contents' property of the DTDL element that corresponds to this object.

Declaration

public IReadOnlyDictionary<string, DTContentInfo> Contents { get; }

Property Value

Type	Description
IReadOnlyDictionary<string, DTContentInfo>	The 'contents' property of the DTDL element.

ExtendedBy

Gets a list of DTInterfaceInfo objects whose 'extends' property identifies the DTDL element corresponding to this object.

Declaration

public IReadOnlyList<DTInterfaceInfo> ExtendedBy { get; }

Property Value

Type	Description
IReadOnlyList<DTInterfaceInfo>	The DTInterfaceInfo objects whose 'extends' property refers to this object.

Extends

Gets the values of the 'extends' property of the DTDL element that corresponds to this object.

Declaration

public IReadOnlyList<DTInterfaceInfo> Extends { get; }

Property Value

Type	Description
IReadOnlyList<DTInterfaceInfo>	The 'extends' property of the DTDL element.

Properties

Gets a subset of values from the 'contents' property of the corresponding DTDL element, for which the values have type Property.

Declaration

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

Property Value

Type	Description
IReadOnlyDictionary<string, DTPropertyInfo>	The Property values from the 'contents' property of the DTDL element.

Relationships

Gets a subset of values from the 'contents' property of the corresponding DTDL element, for which the values have type Relationship.

Declaration

public IReadOnlyDictionary<string, DTRelationshipInfo> Relationships { get; }

Property Value

Type	Description
IReadOnlyDictionary<string, DTRelationshipInfo>	The Relationship values from the 'contents' property of the DTDL element.

Schemas

Gets the values of the 'schemas' property of the DTDL element that corresponds to this object.

Declaration

public IReadOnlyList<DTComplexSchemaInfo> Schemas { get; }

Property Value

Type	Description
IReadOnlyList<DTComplexSchemaInfo>	The 'schemas' property of the DTDL element.

SupplementalProperties

Gets the supplemantal properties of the DTDL element that corresponds to this object.

Declaration

public override IDictionary<string, object> SupplementalProperties { get; }

Property Value

Type	Description
IDictionary<string, object>	A dictionary that maps each string-valued property name to an object that holds the value of the property with the given name.

Overrides

DTEntityInfo.SupplementalProperties

Remarks

If the property is a literal in the DTDL model, the object holds a literal value. If the property is another DTDL element in the model, the object is the C# object that corresponds to this element.

SupplementalTypes

Gets a collection of identifiers, each of which is a Dtmi that indicates a supplemental type that applies to the DTDL element that corresponds to this object.

Declaration

public override IReadOnlyCollection<Dtmi> SupplementalTypes { get; }

Property Value

Type	Description
IReadOnlyCollection<Dtmi>	A collection of DTMIs indicating the supplemental types that apply to the DTDL element.

Overrides

DTEntityInfo.SupplementalTypes

Telemetries

Gets a subset of values from the 'contents' property of the corresponding DTDL element, for which the values have type Telemetry.

Declaration

public IReadOnlyDictionary<string, DTTelemetryInfo> Telemetries { get; }

Property Value

Type	Description
IReadOnlyDictionary<string, DTTelemetryInfo>	The Telemetry values from the 'contents' property of the DTDL element.

Methods

DeepEquals(DTEntityInfo)

Compares to another DTEntityInfo object, recursing through the entire subtree of object properties.

Declaration

public override bool DeepEquals(DTEntityInfo other)

Parameters

Type	Name	Description
DTEntityInfo	other	The other DTEntityInfo object to compare to.

Returns

Type	Description
bool	True if equal.

Overrides

DTEntityInfo.DeepEquals(DTEntityInfo)

DeepEquals(DTInterfaceInfo)

Compares to another DTInterfaceInfo object, recursing through the entire subtree of object properties.

Declaration

public virtual bool DeepEquals(DTInterfaceInfo other)

Parameters

Type	Name	Description
DTInterfaceInfo	other	The other DTInterfaceInfo object to compare to.

Returns

Type	Description
bool	True if equal.

Equals(DTEntityInfo)

Compares to another DTEntityInfo object.

Declaration

public override bool Equals(DTEntityInfo other)

Parameters

Type	Name	Description
DTEntityInfo	other	The other DTEntityInfo object to compare to.

Returns

Type	Description
bool	True if equal.

Overrides

DTEntityInfo.Equals(DTEntityInfo)

Equals(DTInterfaceInfo)

Compares to another DTInterfaceInfo object.

Declaration

public virtual bool Equals(DTInterfaceInfo other)

Parameters

Type	Name	Description
DTInterfaceInfo	other	The other DTInterfaceInfo object to compare to.

Returns

Type	Description
bool	True if equal.

GetJsonLd()

Gets a JsonElement that holds the portion of the DTDL model that defines this rootable element.

Declaration

public JsonElement GetJsonLd()

Returns

Type	Description
JsonElement	A JsonElement object containing the JSON structure.

GetJsonLdText()

Gets a JSON string that holds the portion of the DTDL model that defines this rootable element.

Declaration

public string GetJsonLdText()

Returns

Type	Description
string	A string containing the JSON text.

Operators

operator ==(DTInterfaceInfo, DTInterfaceInfo)

Determines whether two DTInterfaceInfo objects are equal.

Declaration

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

Parameters

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

Returns

Type	Description
bool	True if equal.

operator !=(DTInterfaceInfo, DTInterfaceInfo)

Determines whether two DTInterfaceInfo objects are not equal.

Declaration

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

Parameters

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

Returns

Type	Description
bool	True if not equal.

Implements

IEquatable<T>

IRootable

IEquatable<T>