Class RgbAll

Namespace

Harp.Behavior

Assembly

Harp.Behavior.dll

Represents a register that specifies the state of all RGB LED channels.

public class RgbAll

Inheritance

object

RgbAll

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

public const int Address = 70

Field Value

int

RegisterLength

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

public const int RegisterLength = 6

Field Value

int

RegisterType

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

public const PayloadType RegisterType = U8

Field Value

PayloadType

Methods

FromPayload(MessageType, RgbAllPayload)

Returns a Harp message for the RgbAll register.

public static HarpMessage FromPayload(MessageType messageType, RgbAllPayload value)

Parameters

messageType MessageType

The type of the Harp message.

value RgbAllPayload

The value to be stored in the message payload.

Returns

HarpMessage

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

FromPayload(double, MessageType, RgbAllPayload)

Returns a timestamped Harp message for the RgbAll register.

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

Parameters

timestamp double

The timestamp of the message payload, in seconds.

messageType MessageType

The type of the Harp message.

value RgbAllPayload

The value to be stored in the message payload.

Returns

HarpMessage

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

GetPayload(HarpMessage)

Returns the payload data for RgbAll register messages.

public static RgbAllPayload GetPayload(HarpMessage message)

Parameters

message HarpMessage

A HarpMessage object representing the register message.

Returns

RgbAllPayload

A value representing the message payload.

GetTimestampedPayload(HarpMessage)

Returns the timestamped payload data for RgbAll register messages.

public static Timestamped<RgbAllPayload> GetTimestampedPayload(HarpMessage message)

Parameters

message HarpMessage

A HarpMessage object representing the register message.

Returns

Timestamped<RgbAllPayload>

A value representing the timestamped message payload.