Class DTFieldInfo

Class DTFieldInfo corresponds to an element of type Field in a DTDL model.

Inheritance
object
DTEntityInfo
DTNamedEntityInfo
DTSchemaFieldInfo
DTFieldInfo
Implements
Inherited Members
Namespace: DTDLParser.Models
Assembly: DTDLParser.dll
Syntax
public class DTFieldInfo : DTSchemaFieldInfo, IEquatable<DTEntityInfo>, IEquatable<DTNamedEntityInfo>, IEquatable<DTSchemaFieldInfo>, IEquatable<DTFieldInfo>

Properties

| Edit this page View Source

ClassId

Get the DTMI that identifies type Field 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 Field.
Overrides
| Edit this page View Source

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
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.

| Edit this page View Source

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

Methods

| Edit this page View Source

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
| Edit this page View Source

DeepEquals(DTFieldInfo)

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

Declaration
public virtual bool DeepEquals(DTFieldInfo other)
Parameters
Type Name Description
DTFieldInfo other

The other DTFieldInfo object to compare to.
Returns
Type Description
bool

True if equal.
| Edit this page View Source

DeepEquals(DTNamedEntityInfo)

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

Declaration
public override bool DeepEquals(DTNamedEntityInfo other)
Parameters
Type Name Description
DTNamedEntityInfo other

The other DTNamedEntityInfo object to compare to.
Returns
Type Description
bool

True if equal.
Overrides
| Edit this page View Source

DeepEquals(DTSchemaFieldInfo)

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

Declaration
public override bool DeepEquals(DTSchemaFieldInfo other)
Parameters
Type Name Description
DTSchemaFieldInfo other

The other DTSchemaFieldInfo object to compare to.
Returns
Type Description
bool

True if equal.
Overrides
| Edit this page View Source

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
| Edit this page View Source

Equals(DTFieldInfo)

Compares to another DTFieldInfo object.

Declaration
public virtual bool Equals(DTFieldInfo other)
Parameters
Type Name Description
DTFieldInfo other

The other DTFieldInfo object to compare to.
Returns
Type Description
bool

True if equal.
| Edit this page View Source

Equals(DTNamedEntityInfo)

Compares to another DTNamedEntityInfo object.

Declaration
public override bool Equals(DTNamedEntityInfo other)
Parameters
Type Name Description
DTNamedEntityInfo other

The other DTNamedEntityInfo object to compare to.
Returns
Type Description
bool

True if equal.
Overrides
| Edit this page View Source

Equals(DTSchemaFieldInfo)

Compares to another DTSchemaFieldInfo object.

Declaration
public override bool Equals(DTSchemaFieldInfo other)
Parameters
Type Name Description
DTSchemaFieldInfo other

The other DTSchemaFieldInfo object to compare to.
Returns
Type Description
bool

True if equal.
Overrides
| Edit this page View Source

ValidateInstance(JsonElement)

Validate a JsonElement to determine whether it conforms to the specific Field element defined in the model.

Declaration
public override IReadOnlyCollection<string> ValidateInstance(JsonElement instanceElt)
Parameters
Type Name Description
JsonElement instanceElt

The JsonElement to validate.
Returns
Type Description
IReadOnlyCollection<string>

A list of strings that each indicate a validation failure; the list is empty if the JsonElement conforms.
Overrides

Operators

| Edit this page View Source

operator ==(DTFieldInfo, DTFieldInfo)

Determines whether two DTFieldInfo objects are equal.

Declaration
public static bool operator ==(DTFieldInfo x, DTFieldInfo y)
Parameters
Type Name Description
DTFieldInfo x

One DTFieldInfo object to compare.
DTFieldInfo y

Another DTFieldInfo object to compare to the first.
Returns
Type Description
bool

True if equal.
| Edit this page View Source

operator !=(DTFieldInfo, DTFieldInfo)

Determines whether two DTFieldInfo objects are not equal.

Declaration
public static bool operator !=(DTFieldInfo x, DTFieldInfo y)
Parameters
Type Name Description
DTFieldInfo x

One DTFieldInfo object to compare.
DTFieldInfo y

Another DTFieldInfo object to compare to the first.
Returns
Type Description
bool

True if not equal.

Implements