Class BatteryRate

Namespace

Harp.TimestampGeneratorGen3

Assembly

Harp.TimestampGeneratorGen3.dll

Represents a register that configure how often the battery calue is sent to computer.

public class BatteryRate

Inheritance

object

BatteryRate

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 BatteryRate register. This field is constant.

public const int Address = 35

Field Value

int

RegisterLength

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

public const int RegisterLength = 1

Field Value

int

RegisterType

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

public const PayloadType RegisterType = U8

Field Value

PayloadType

Methods

FromPayload(MessageType, BatteryRateConfiguration)

Returns a Harp message for the BatteryRate register.

public static HarpMessage FromPayload(MessageType messageType, BatteryRateConfiguration value)

Parameters

messageType MessageType

The type of the Harp message.

value BatteryRateConfiguration

The value to be stored in the message payload.

Returns

HarpMessage

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

FromPayload(double, MessageType, BatteryRateConfiguration)

Returns a timestamped Harp message for the BatteryRate register.

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

Parameters

timestamp double

The timestamp of the message payload, in seconds.

messageType MessageType

The type of the Harp message.

value BatteryRateConfiguration

The value to be stored in the message payload.

Returns

HarpMessage

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

GetPayload(HarpMessage)

Returns the payload data for BatteryRate register messages.

public static BatteryRateConfiguration GetPayload(HarpMessage message)

Parameters

message HarpMessage

A HarpMessage object representing the register message.

Returns

BatteryRateConfiguration

A value representing the message payload.

GetTimestampedPayload(HarpMessage)

Returns the timestamped payload data for BatteryRate register messages.

public static Timestamped<BatteryRateConfiguration> GetTimestampedPayload(HarpMessage message)

Parameters

message HarpMessage

A HarpMessage object representing the register message.

Returns

Timestamped<BatteryRateConfiguration>

A value representing the timestamped message payload.