Class ThirdPartyEnhancedFaultRecord

Namespace

Geotab.StoreForward

Assembly

Geotab.Checkmate.ObjectModel.dll

false A data record class used to add enhanced fault data for third-party devices.

public class ThirdPartyEnhancedFaultRecord : ThirdPartyDataRecord

Inheritance

object

SoftwareGeneratedDataRecord

ThirdPartyDataRecord

ThirdPartyEnhancedFaultRecord

Inherited Members

ThirdPartyDataRecord.GetHardwareId()

ThirdPartyDataRecord.IsValidHardwareId(int?)

ThirdPartyDataRecord.GetParsedHardwareId()

ThirdPartyDataRecord.SerialNo

ThirdPartyDataRecord.HardwareId

ThirdPartyDataRecord.Type

SoftwareGeneratedDataRecord.EncodeDateTime(in Span<byte>, int, DateTime?)

SoftwareGeneratedDataRecord.GetDateTimeValue(DateTime?)

SoftwareGeneratedDataRecord.EncodeSubSeconds(in Span<byte>, int, DateTime?)

SoftwareGeneratedDataRecord.GetSubSecondsValue(DateTime?)

SoftwareGeneratedDataRecord.DateTime

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

ThirdPartyEnhancedFaultRecord()

Initializes a new instance of the ThirdPartyEnhancedFaultRecord class. Creates an enhanced fault record for a third-party device.

public ThirdPartyEnhancedFaultRecord()

ThirdPartyEnhancedFaultRecord(string, in DateTime, byte, ushort, byte, byte, byte, byte, byte?, byte?, byte?)

Initializes a new instance of the ThirdPartyEnhancedFaultRecord class. Creates an enhanced fault record for a third-party device.

public ThirdPartyEnhancedFaultRecord(string serialNo, in DateTime dateTime, byte faultType, ushort sourceAddress, byte status, byte dtcByte1, byte dtcByte2, byte dtcByte3, byte? format, byte? severityCode, byte? classCode)

Parameters

serialNo string

The serial number.

dateTime DateTime

The date time.

faultType byte

The faultType.

sourceAddress ushort

The sourceAddress.

status byte

The status.

dtcByte1 byte

The dtcByte1.

dtcByte2 byte

The dtcByte2.

dtcByte3 byte

The dtcByte3.

format byte?

The format.

severityCode byte?

The severityCode.

classCode byte?

The classCode.

Properties

ClassCode

Gets or sets the fault class code (Maximum: 31).

public byte? ClassCode { get; set; }

Property Value

byte?

The fault class code

DtcByte1

Gets or sets fault DTC Byte 1 (3 bytes in all).

public byte DtcByte1 { get; set; }

Property Value

byte

The DTC Byte 1

DtcByte2

Gets or sets fault DTC Byte 2 (3 bytes in all).

public byte DtcByte2 { get; set; }

Property Value

byte

The DTC Byte 2

DtcByte3

Gets or sets fault DTC Byte 3 (3 bytes in all).

public byte DtcByte3 { get; set; }

Property Value

byte

The DTC Byte 3

FaultType

Gets or sets the fault type.

public byte FaultType { get; set; }

Property Value

byte

The fault type

Format

Gets or sets the DTC format identifier.

public byte? Format { get; set; }

Property Value

byte?

The DTC format identifier

SeverityCode

Gets or sets the fault severity code (Maximum: 7).

public byte? SeverityCode { get; set; }

Property Value

byte?

The fault severity code

SourceAddress

Gets or sets source address (CAN ID).

public ushort SourceAddress { get; set; }

Property Value

ushort

The source address

Status

Gets or sets the fault status.

public byte Status { get; set; }

Property Value

byte

The fault status

Methods

CreateBinaryData()

Converts the record into binary data to be inserted into the database.

public override byte[] CreateBinaryData()

Returns

byte[]

The binary data array.

ValidateSeverityAndClassCodes()

Validates SeverityCode and ClassCode and throws error either is out of range.

public void ValidateSeverityAndClassCodes()

Exceptions

InvalidOperationException

Thrown when either SeverityCode or ClassCode is invalid range value