Table of Contents

Class FaultData

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

A record that represents a fault code record from the engine system of the specific Device.

[ReportClass]
public class FaultData : Entity, IEntity, IComparable, IIdentifiable, IDateTimeProvider, IDiagnosticProvider, IDeviceProvider, IDefaultable
Inheritance
FaultData
Implements
Derived
Inherited Members

Constructors

FaultData()

Initializes a new instance of the FaultData class.Initializes a new instance of the FaultData class.

public FaultData()

FaultData(FaultData)

Initializes a new instance of the FaultData class.Initializes a new instance of the FaultData class.

protected FaultData(FaultData faultData)

Parameters

faultData FaultData

The fault data.

FaultData(Id?, Device?, DateTime?, int?, FailureMode?, Controller?, Diagnostic?, FaultStatus, bool?, bool?, bool?, bool?, DateTime?, User?, DtcSeverity?, DtcClass?, int?, string?, string?, string?)

Initializes a new instance of the FaultData class.Initializes a new instance of the FaultData class.

public FaultData(Id? id, Device? device, DateTime? dateTime, int? count, FailureMode? failureMode, Controller? controller, Diagnostic? diagnostic, FaultStatus faultStatus, bool? malfunctionLamp, bool? redStopLamp, bool? amberWarningLamp, bool? protectWarningLamp, DateTime? dismissDateTime, User? dismissUser, DtcSeverity? severity = null, DtcClass? classCode = null, int? sourceAddress = null, string? recommendation = null, string? effectOnComponent = null, string? faultDescription = null)

Parameters

id Id

The Id.

device Device

The go engine vehicle.

dateTime DateTime?

The log DateTime.

count int?

The count.

failureMode FailureMode

The failure mode.

controller Controller

The controller.

diagnostic Diagnostic

The diagnostic.

faultStatus FaultStatus

A single fault status.

malfunctionLamp bool?

The malfunction lamp.

redStopLamp bool?

The red stop lamp.

amberWarningLamp bool?

The amber warning lamp.

protectWarningLamp bool?

The protect warning lamp.

dismissDateTime DateTime?

The dismiss DateTime.

dismissUser User

The dismiss user.

severity DtcSeverity?

The severity.

classCode DtcClass?

The class code.

sourceAddress int?

The source address for enhanced faults.

recommendation string

The recommendation for enriched fault.

effectOnComponent string

The effect on component for enriched fault.

faultDescription string

The fault description for enriched fault.

FaultData(Id?, Device?, DateTime?, int?, FailureMode?, Controller?, Diagnostic?, IFaultStateProvider?, bool?, bool?, bool?, bool?, DateTime?, User?, DtcSeverity?, DtcClass?, int?, string?, string?, string?)

Initializes a new instance of the FaultData class.Initializes a new instance of the FaultData class.

public FaultData(Id? id, Device? device, DateTime? dateTime, int? count, FailureMode? failureMode, Controller? controller, Diagnostic? diagnostic, IFaultStateProvider? faultStateProvider, bool? malfunctionLamp, bool? redStopLamp, bool? amberWarningLamp, bool? protectWarningLamp, DateTime? dismissDateTime, User? dismissUser, DtcSeverity? severity, DtcClass? classCode, int? sourceAddress, string? recommendation, string? effectOnComponent, string? faultDescription)

Parameters

id Id

The Id.

device Device

The go engine vehicle.

dateTime DateTime?

The log DateTime.

count int?

The count.

failureMode FailureMode

The failure mode.

controller Controller

The controller.

diagnostic Diagnostic

The diagnostic.

faultStateProvider IFaultStateProvider

The provider of FaultStatus details.

malfunctionLamp bool?

The malfunction lamp.

redStopLamp bool?

The red stop lamp.

amberWarningLamp bool?

The amber warning lamp.

protectWarningLamp bool?

The protect warning lamp.

dismissDateTime DateTime?

The dismiss DateTime.

dismissUser User

The dismiss user.

severity DtcSeverity?

The severity.

classCode DtcClass?

The class code.

sourceAddress int?

The source address for enhanced faults.

recommendation string

The recommendation for enriched fault.

effectOnComponent string

The effect on component for enriched fault.

faultDescription string

The fault description for enriched fault.

FaultData(Id?, Device?, DateTime?, int?, FailureMode?, Controller?, Diagnostic?, IEnumerable<FaultStatus>, bool?, bool?, bool?, bool?, DateTime?, User?, DtcSeverity?, DtcClass?, int?, string?, string?, string?)

Initializes a new instance of the FaultData class.Initializes a new instance of the FaultData class.

public FaultData(Id? id, Device? device, DateTime? dateTime, int? count, FailureMode? failureMode, Controller? controller, Diagnostic? diagnostic, IEnumerable<FaultStatus> faultStates, bool? malfunctionLamp, bool? redStopLamp, bool? amberWarningLamp, bool? protectWarningLamp, DateTime? dismissDateTime, User? dismissUser, DtcSeverity? severity = null, DtcClass? classCode = null, int? sourceAddress = null, string? recommendation = null, string? effectOnComponent = null, string? faultDescription = null)

Parameters

id Id

The Id.

device Device

The go engine vehicle.

dateTime DateTime?

The log DateTime.

count int?

The count.

failureMode FailureMode

The failure mode.

controller Controller

The controller.

diagnostic Diagnostic

The diagnostic.

faultStates IEnumerable<FaultStatus>

A collection of FaultStatus details.

malfunctionLamp bool?

The malfunction lamp.

redStopLamp bool?

The red stop lamp.

amberWarningLamp bool?

The amber warning lamp.

protectWarningLamp bool?

The protect warning lamp.

dismissDateTime DateTime?

The dismiss DateTime.

dismissUser User

The dismiss user.

severity DtcSeverity?

The severity.

classCode DtcClass?

The class code.

sourceAddress int?

The source address for enhanced faults.

recommendation string

The recommendation for enriched fault.

effectOnComponent string

The effect on component for enriched fault.

faultDescription string

The fault description for enriched fault.

Properties

AmberWarningLamp

Gets or sets whether the amber warning lamp state.

[ExcelColumnHeader(new ReportHeading[] { ReportHeading.FaultDataAmberWarningLamp })]
public bool? AmberWarningLamp { get; set; }

Property Value

bool?

bool

ClassCode

Gets or sets the DtcClass code of the fault.

[ExcelColumnHeader(new ReportHeading[] { ReportHeading.FaultDataClass })]
public DtcClass? ClassCode { get; set; }

Property Value

DtcClass?

DtcClass

Controller

Gets or sets the Controller code related to the fault code; if applicable.

public Controller? Controller { get; set; }

Property Value

Controller

Controller

Count

Gets or sets the number of times the fault occurred.

[ExcelColumnHeader(new ReportHeading[] { ReportHeading.FaultDataCount })]
public int? Count { get; set; }

Property Value

int?

int

DateTime

Gets or sets the date and time at which the event occurred.

[ExcelColumnHeader(new ReportHeading[] { ReportHeading.FaultDataDateTime })]
public DateTime? DateTime { get; set; }

Property Value

DateTime?

DateTime

Device

Gets or sets the Device that generated the fault.

public Device? Device { get; set; }

Property Value

Device

Device

Diagnostic

Gets or sets the Diagnostic associated with the fault.

public Diagnostic? Diagnostic { get; set; }

Property Value

Diagnostic

Diagnostic

DismissDateTime

Gets or sets the date and time that the DismissUser dismissed the fault.

[ExcelColumnHeader(new ReportHeading[] { ReportHeading.FaultDataDismissDateTime })]
public DateTime? DismissDateTime { get; set; }

Property Value

DateTime?

DateTime

DismissUser

Gets or sets the User that dismissed the fault.

public User? DismissUser { get; set; }

Property Value

User

User

EffectOnComponent

Gets or sets the effect on component for enriched fault.

[ExcelColumnHeader(new ReportHeading[] { ReportHeading.EffectOnComponent })]
public string? EffectOnComponent { get; set; }

Property Value

string

string

FailureMode

Gets or sets the FailureMode of the fault; if applicable.

public FailureMode? FailureMode { get; set; }

Property Value

FailureMode

FailureMode

FaultDescription

Gets or sets the fault description for enriched fault.

[ExcelColumnHeader(new ReportHeading[] { ReportHeading.FaultDescription })]
public string? FaultDescription { get; set; }

Property Value

string

string

FaultLampState

Gets or sets the FaultLampState of a J1939 vehicle. See FaultLampState for the possible values.

[ExcelColumnHeader(new ReportHeading[] { ReportHeading.FaultDataFaultLampState })]
public FaultLampState? FaultLampState { get; set; }

Property Value

FaultLampState?

FaultLampState

FaultState

Gets or sets the FaultState code from the engine system of the specific device.

[ExcelColumnHeader(new ReportHeading[] { ReportHeading.FaultDataFaultState })]
public FaultState? FaultState { get; set; }

Property Value

FaultState?

FaultState

FaultStates

Gets or sets the FaultStatus(s) from the engine system of the specific device.

[ExcelColumnHeader(new ReportHeading[] { ReportHeading.FaultDataStatus })]
public IFaultStateProvider? FaultStates { get; set; }

Property Value

IFaultStateProvider

List<T>

FlashCode

Gets or sets the FlashCode associated with the fault.

public FlashCode? FlashCode { get; set; }

Property Value

FlashCode

FlashCode

Id

Gets or sets the unique identifier for the entity. See Id.

[ExcelColumnHeader(new ReportHeading[] { ReportHeading.FaultDataId })]
public override Id? Id { get; set; }

Property Value

Id

Id

MalfunctionLamp

Gets or sets the malfunction light state.

[ExcelColumnHeader(new ReportHeading[] { ReportHeading.FaultDataMalfunctionLamp })]
public bool? MalfunctionLamp { get; set; }

Property Value

bool?

bool

ProtectWarningLamp

Gets or sets whether the protect warning lamp is on.

[ExcelColumnHeader(new ReportHeading[] { ReportHeading.FaultDataProtectWarningLamp })]
public bool? ProtectWarningLamp { get; set; }

Property Value

bool?

bool

Recommendation

Gets or sets the recommendation for enriched fault.

[ExcelColumnHeader(new ReportHeading[] { ReportHeading.Recommendation })]
public string? Recommendation { get; set; }

Property Value

string

string

RedStopLamp

Gets or sets whether the red stop lamp is on.

[ExcelColumnHeader(new ReportHeading[] { ReportHeading.FaultDataRedStopLamp })]
public bool? RedStopLamp { get; set; }

Property Value

bool?

bool

Severity

Gets or sets the DtcSeverity of the fault.

[ExcelColumnHeader(new ReportHeading[] { ReportHeading.FaultDataSeverity })]
public DtcSeverity? Severity { get; set; }

Property Value

DtcSeverity?

DtcSeverity

SourceAddress

Gets or sets the source address for enhanced faults.

[ExcelColumnHeader(new ReportHeading[] { ReportHeading.FaultDataSourceAddress })]
public int? SourceAddress { get; set; }

Property Value

int?

int

Methods

Clone()

Creates a new object that is a copy of the current instance.

public override IEntity Clone()

Returns

IEntity

A new object that is a copy of this instance.

GetCodeString()

Get standardized representation of the fault code.

public string? GetCodeString()

Returns

string

string.

GetFaultStatusKnownId(FaultState?)

Returns a KnownId for FaultStatus from the provided system FaultState.

public static Id GetFaultStatusKnownId(FaultState? faultState)

Parameters

faultState FaultState?

The FaultState.

Returns

Id

The KnownId.

PopulateDefaults()

Populate non-required empty (null) properties with default values.

public void PopulateDefaults()

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.