Class ParsingError

Provides information about a model error that was discovered during DTDL parsing.

Inheritance

object

ParsingError

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: DTDLParser

Assembly: DTDLParser.dll

Syntax

public class ParsingError

Properties

Action

Gets a textual description of an action to resolve the error.

Declaration

public string Action { get; }

Property Value

Type	Description
string	A description of the recommeded action.

AuxProperty

Gets an auxiliary property in the model relating to the error, if any.

Declaration

public string AuxProperty { get; }

Property Value

Type	Description
string	The relevant auxiliary property.

Cause

Gets a textual description of the cause of the error.

Declaration

public string Cause { get; }

Property Value

Type	Description
string	A description of the error cause.

Layer

Gets the name of the layer in which the error was found, if any.

Declaration

public string Layer { get; }

Property Value

Type	Description
string	Name of the relevant layer.

Remarks

If layers are not supported, the value can be ignored, since it will always be the empty string.

Message

Gets a textual message describing the error; this is a concatenation of Cause and Action.

Declaration

public string Message { get; }

Property Value

Type	Description
string

PrimaryID

Gets the primary identifier of an element in the model relating to the error, if any.

Declaration

public Uri PrimaryID { get; }

Property Value

Type	Description
Uri	The ID of a relevant element.

PrimaryLocationEnd

Gets the ending line number within the source file where the error is primarily in evidence, or zero if not determinable.

Declaration

public int PrimaryLocationEnd { get; }

Property Value

Type	Description
int	Ending line number of the error.

PrimaryLocationName

Gets the name of the source file in which the error is primarily in evidence, or null if not determinable.

Declaration

public string PrimaryLocationName { get; }

Property Value

Type	Description
string	The source name, commonly a file name.

PrimaryLocationStart

Gets the starting line number within the source file where the error is primarily in evidence, or zero if not determinable.

Declaration

public int PrimaryLocationStart { get; }

Property Value

Type	Description
int	Starting line number of the error.

Property

Gets the specific property in the model relating to the error, if any.

Declaration

public string Property { get; }

Property Value

Type	Description
string	The relevant property.

Restriction

Gets a string characterizing a restriction on permissible values, if such a restriction has been violated.

Declaration

public string Restriction { get; }

Property Value

Type	Description
string	A string description of the relevant restriction.

SecondaryID

Gets the secondary identifier of an element in the model relating to the error, if any.

Declaration

public Uri SecondaryID { get; }

Property Value

Type	Description
Uri	The ID of a relevant element.

SecondaryLocationEnd

Gets the ending line number within the source file where the error is secondarily in evidence, or zero if none or not determinable.

Declaration

public int SecondaryLocationEnd { get; }

Property Value

Type	Description
int	Ending line number of the error.

SecondaryLocationName

Gets the name of the source file in which the error is secondarily in evidence, or null if none or not determinable.

Declaration

public string SecondaryLocationName { get; }

Property Value

Type	Description
string	The source name, commonly a file name.

SecondaryLocationStart

Gets the starting line number within the source file where the error is secondarily in evidence, or zero if none or not determinable.

Declaration

public int SecondaryLocationStart { get; }

Property Value

Type	Description
int	Starting line number of the error.

Transformation

Gets a string characterizing a transformation whose application caused the error.

Declaration

public string Transformation { get; }

Property Value

Type	Description
string	A string description of the relevant transformation.

Type

Gets the type of the specific property in the model relating to the error, if any.

Declaration

public string Type { get; }

Property Value

Type	Description
string	The relevant type.

ValidationID

Gets a valididation ID that characterizes the category of error.

Declaration

public Uri ValidationID { get; }

Property Value

Type	Description
Uri	A unique identifier for the category of error.

Value

Gets the value of the specific property in the model relating to the error, if any.

Declaration

public string Value { get; }

Property Value

Type	Description
string	The relevant property value.

Violations

Gets a collection of strings that each indicate a validation failure, if there are any.

Declaration

public IReadOnlyCollection<string> Violations { get; }

Property Value

Type	Description
IReadOnlyCollection<string>	A list of strings, one per validation failure.

Methods

ToString()

Returns a string that represents the current object.

Declaration

public override string ToString()

Returns

Type	Description
string	A string that represents the current object.

Overrides

object.ToString()