TINMAN 3D / REALTIME TERRAIN
Software Development Kit - User Manual

class ValidatePath in Tinman.Core.Validating

sealed class ValidatePath implements IComparable<ValidatePath>
  IEquatable<ValidatePath>

Public / Constants

None

An empty path.

public static readonly field None
type ValidatePath

Public / Attributes

Culprit

The object that has caused a validation error or warning.

public property Culprit { get }
type ICodeRange
value The culprit object or null if no object has been reported.

Entry

Returns the entry value of the first path element.

public property Entry { get }
type string
value The entry value or null if Type is not Entry.

Index

Returns the index of the first path element.

public property Index { get }
type int32
value The index or -1 if Type is not Index.

Length

Returns the length of this path.

public property Length { get }
type int32
value [>=0] The length, in path elements (see ValidatePathElement).

Member

Returns the member name of the first path element.

public property Member { get }
type string
value The member name or null if Type is not Member.

Type

Returns the type of the first element of this path.

public property Type { get }
type ValidatePathElement
value The path element type.

Public / Methods

CompareTo

Compares this object with the given one.

[Pure]
public method CompareTo (ValidatePath other)
type int32
params other The object to compare to.
returns < 0 : if this object is less than other,
= 0 : if this object is equal to other,
> 0 : if this object is greater than other.
implements IComparable.CompareTo

Concat

Concatenates the given paths.

public static method Concat (ValidatePath first, ValidatePath second)
type ValidatePath
params first First path value or null.
  second Second path value or null.
returns The resulting path value or null if empty.

CutFirst

Removes the first element from this path.

public method CutFirst ()
type ValidatePath
returns The resulting path or null if empty.

Equals

Compares this object with the given one.

[Pure]
public method Equals (ValidatePath other)
type bool
params other The object to compare to.
returns true if this object is equal to other, false if not.
implements IEquatable.Equals

ToString

[Pure]
public override method ToString ()
type string

Formats this validation path as a string.

public method ToString (StringBuilder sb)
params sb [not-null] The string builder to use.