Class DTCommandPayloadInfo

Class DTCommandPayloadInfo corresponds to an element of type CommandPayload in a DTDL model.

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

Properties

| Edit this page View Source

ClassId

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

Nullable

Gets the value of the 'nullable' property of the DTDL element that corresponds to this object.

Declaration
public bool Nullable { get; }
Property Value
Type Description
bool

The 'nullable' property of the DTDL element.
| 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(DTCommandPayloadInfo)

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

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

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

True if equal.
| 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(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(DTCommandPayloadInfo)

Compares to another DTCommandPayloadInfo object.

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

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

True if equal.
| 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(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

Operators

| Edit this page View Source

operator ==(DTCommandPayloadInfo, DTCommandPayloadInfo)

Determines whether two DTCommandPayloadInfo objects are equal.

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

One DTCommandPayloadInfo object to compare.
DTCommandPayloadInfo y

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

True if equal.
| Edit this page View Source

operator !=(DTCommandPayloadInfo, DTCommandPayloadInfo)

Determines whether two DTCommandPayloadInfo objects are not equal.

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

One DTCommandPayloadInfo object to compare.
DTCommandPayloadInfo y

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

True if not equal.

Implements