Table of Contents

Class FaultStatus

Namespace
Geotab.Checkmate.ObjectModel.Engine
Assembly
Geotab.Checkmate.ObjectModel.dll

Class to describe FaultState.

[ReportClass]
public abstract class FaultStatus : NameEntity, IEntity, IComparable, IIdentifiable
Inheritance
FaultStatus
Implements
Derived
Inherited Members

Constructors

FaultStatus()

Initializes a new instance of the FaultStatus class.

protected FaultStatus()

FaultStatus(Id, string)

Initializes a new instance of the FaultStatus class.

protected FaultStatus(Id id, string name)

Parameters

id Id

The Id.

name string

The name.

Methods

GetStateFromId(Id, bool)

Returns a system FaultState from the provided system Id. In the case a match is missing, the default value will be FaultStateNone.

public static FaultState GetStateFromId(Id id, bool isLegacy = false)

Parameters

id Id

The id of the FaultStatus.

isLegacy bool

Whether or not to return legacy FaultStates.

Returns

FaultState

The FaultState.

IsSystemEntity()

Returns true if the class is a system entity, false otherwise.

public override bool IsSystemEntity()

Returns

bool

true if the entity is a system entity; otherwise, false.

SystemFromId(Id)

Returns a system FaultStatus from the provided system Id. In the case a match is missing, the default value will be FaultStatusNone.

public static FaultStatus SystemFromId(Id id)

Parameters

id Id

The id.

Returns

FaultStatus

The FaultStatus.