Class PulseRgb0
Represents a register that specifies the duration of the output pulse in milliseconds.
public class PulseRgb0
- Inheritance
-
PulseRgb0
- Inherited Members
Fields
Address
Represents the address of the PulseRgb0 register. This field is constant.
public const int Address = 54
Field Value
RegisterLength
Represents the length of the PulseRgb0 register. This field is constant.
public const int RegisterLength = 1
Field Value
RegisterType
Represents the payload type of the PulseRgb0 register. This field is constant.
public const PayloadType RegisterType = U16
Field Value
Methods
FromPayload(MessageType, ushort)
Returns a Harp message for the PulseRgb0 register.
public static HarpMessage FromPayload(MessageType messageType, ushort value)
Parameters
messageType
MessageTypeThe type of the Harp message.
value
ushortThe value to be stored in the message payload.
Returns
- HarpMessage
A HarpMessage object for the PulseRgb0 register with the specified message type and payload.
FromPayload(double, MessageType, ushort)
Returns a timestamped Harp message for the PulseRgb0 register.
public static HarpMessage FromPayload(double timestamp, MessageType messageType, ushort value)
Parameters
timestamp
doubleThe timestamp of the message payload, in seconds.
messageType
MessageTypeThe type of the Harp message.
value
ushortThe value to be stored in the message payload.
Returns
- HarpMessage
A HarpMessage object for the PulseRgb0 register with the specified message type, timestamp, and payload.
GetPayload(HarpMessage)
Returns the payload data for PulseRgb0 register messages.
public static ushort GetPayload(HarpMessage message)
Parameters
message
HarpMessageA HarpMessage object representing the register message.
Returns
- ushort
A value representing the message payload.
GetTimestampedPayload(HarpMessage)
Returns the timestamped payload data for PulseRgb0 register messages.
public static Timestamped<ushort> GetTimestampedPayload(HarpMessage message)
Parameters
message
HarpMessageA HarpMessage object representing the register message.
Returns
- Timestamped<ushort>
A value representing the timestamped message payload.