Class PulseMode

Namespace

Harp.LedArray

Assembly

Harp.LedArray.dll

Represents a register that sets the pulse mode used by the LEDs.

public class PulseMode

Inheritance

object

PulseMode

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

public const int Address = 38

Field Value

int

RegisterLength

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

public const int RegisterLength = 1

Field Value

int

RegisterType

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

public const PayloadType RegisterType = U8

Field Value

PayloadType

Methods

FromPayload(MessageType, PulseModePayload)

Returns a Harp message for the PulseMode register.

public static HarpMessage FromPayload(MessageType messageType, PulseModePayload value)

Parameters

messageType MessageType

The type of the Harp message.

value PulseModePayload

The value to be stored in the message payload.

Returns

HarpMessage

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

FromPayload(double, MessageType, PulseModePayload)

Returns a timestamped Harp message for the PulseMode register.

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

Parameters

timestamp double

The timestamp of the message payload, in seconds.

messageType MessageType

The type of the Harp message.

value PulseModePayload

The value to be stored in the message payload.

Returns

HarpMessage

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

GetPayload(HarpMessage)

Returns the payload data for PulseMode register messages.

public static PulseModePayload GetPayload(HarpMessage message)

Parameters

message HarpMessage

A HarpMessage object representing the register message.

Returns

PulseModePayload

A value representing the message payload.

GetTimestampedPayload(HarpMessage)

Returns the timestamped payload data for PulseMode register messages.

public static Timestamped<PulseModePayload> GetTimestampedPayload(HarpMessage message)

Parameters

message HarpMessage

A HarpMessage object representing the register message.

Returns

Timestamped<PulseModePayload>

A value representing the timestamped message payload.