Class EnableLedMode

Namespace

Harp.LedArray

Assembly

Harp.LedArray.dll

Represents a register that start/stop the LEDs according to the pulse configuration.

public class EnableLedMode

Inheritance

object

EnableLedMode

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

public const int Address = 33

Field Value

int

RegisterLength

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

public const int RegisterLength = 1

Field Value

int

RegisterType

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

public const PayloadType RegisterType = U8

Field Value

PayloadType

Methods

FromPayload(MessageType, LedState)

Returns a Harp message for the EnableLedMode register.

public static HarpMessage FromPayload(MessageType messageType, LedState value)

Parameters

messageType MessageType

The type of the Harp message.

value LedState

The value to be stored in the message payload.

Returns

HarpMessage

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

FromPayload(double, MessageType, LedState)

Returns a timestamped Harp message for the EnableLedMode register.

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

Parameters

timestamp double

The timestamp of the message payload, in seconds.

messageType MessageType

The type of the Harp message.

value LedState

The value to be stored in the message payload.

Returns

HarpMessage

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

GetPayload(HarpMessage)

Returns the payload data for EnableLedMode register messages.

public static LedState GetPayload(HarpMessage message)

Parameters

message HarpMessage

A HarpMessage object representing the register message.

Returns

LedState

A value representing the message payload.

GetTimestampedPayload(HarpMessage)

Returns the timestamped payload data for EnableLedMode register messages.

public static Timestamped<LedState> GetTimestampedPayload(HarpMessage message)

Parameters

message HarpMessage

A HarpMessage object representing the register message.

Returns

Timestamped<LedState>

A value representing the timestamped message payload.