Class Battery

Namespace

Harp.TimestampGeneratorGen3

Assembly

Harp.TimestampGeneratorGen3.dll

Represents a register that reads the current battery charge.

public class Battery

Inheritance

object

Battery

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Fields

Address

Represents the address of the Battery register. This field is constant.

public const int Address = 36

Field Value

int

RegisterLength

Represents the length of the Battery register. This field is constant.

public const int RegisterLength = 1

Field Value

int

RegisterType

Represents the payload type of the Battery register. This field is constant.

public const PayloadType RegisterType = Float

Field Value

PayloadType

Methods

FromPayload(MessageType, float)

Returns a Harp message for the Battery register.

public static HarpMessage FromPayload(MessageType messageType, float value)

Parameters

messageType MessageType

The type of the Harp message.

value float

The value to be stored in the message payload.

Returns

HarpMessage

A HarpMessage object for the Battery register with the specified message type and payload.

FromPayload(double, MessageType, float)

Returns a timestamped Harp message for the Battery register.

public static HarpMessage FromPayload(double timestamp, MessageType messageType, float value)

Parameters

timestamp double

The timestamp of the message payload, in seconds.

messageType MessageType

The type of the Harp message.

value float

The value to be stored in the message payload.

Returns

HarpMessage

A HarpMessage object for the Battery register with the specified message type, timestamp, and payload.

GetPayload(HarpMessage)

Returns the payload data for Battery register messages.

public static float GetPayload(HarpMessage message)

Parameters

message HarpMessage

A HarpMessage object representing the register message.

Returns

float

A value representing the message payload.

GetTimestampedPayload(HarpMessage)

Returns the timestamped payload data for Battery register messages.

public static Timestamped<float> GetTimestampedPayload(HarpMessage message)

Parameters

message HarpMessage

A HarpMessage object representing the register message.

Returns

Timestamped<float>

A value representing the timestamped message payload.