Class DigitalInputsSamplingMode
- Namespace
- Harp.Synchronizer
- Assembly
- Harp.Synchronizer.dll
Represents a register that sets the sampling mode for digital input pins.
public class DigitalInputsSamplingMode
- Inheritance
-
DigitalInputsSamplingMode
- Inherited Members
Fields
Address
Represents the address of the DigitalInputsSamplingMode register. This field is constant.
public const int Address = 34
Field Value
RegisterLength
Represents the length of the DigitalInputsSamplingMode register. This field is constant.
public const int RegisterLength = 1
Field Value
RegisterType
Represents the payload type of the DigitalInputsSamplingMode register. This field is constant.
public const PayloadType RegisterType = U8
Field Value
Methods
FromPayload(MessageType, DigitalInputsSamplingConfig)
Returns a Harp message for the DigitalInputsSamplingMode register.
public static HarpMessage FromPayload(MessageType messageType, DigitalInputsSamplingConfig value)
Parameters
messageType
MessageTypeThe type of the Harp message.
value
DigitalInputsSamplingConfigThe value to be stored in the message payload.
Returns
- HarpMessage
A HarpMessage object for the DigitalInputsSamplingMode register with the specified message type and payload.
FromPayload(double, MessageType, DigitalInputsSamplingConfig)
Returns a timestamped Harp message for the DigitalInputsSamplingMode register.
public static HarpMessage FromPayload(double timestamp, MessageType messageType, DigitalInputsSamplingConfig value)
Parameters
timestamp
doubleThe timestamp of the message payload, in seconds.
messageType
MessageTypeThe type of the Harp message.
value
DigitalInputsSamplingConfigThe value to be stored in the message payload.
Returns
- HarpMessage
A HarpMessage object for the DigitalInputsSamplingMode register with the specified message type, timestamp, and payload.
GetPayload(HarpMessage)
Returns the payload data for DigitalInputsSamplingMode register messages.
public static DigitalInputsSamplingConfig GetPayload(HarpMessage message)
Parameters
message
HarpMessageA HarpMessage object representing the register message.
Returns
- DigitalInputsSamplingConfig
A value representing the message payload.
GetTimestampedPayload(HarpMessage)
Returns the timestamped payload data for DigitalInputsSamplingMode register messages.
public static Timestamped<DigitalInputsSamplingConfig> GetTimestampedPayload(HarpMessage message)
Parameters
message
HarpMessageA HarpMessage object representing the register message.
Returns
- Timestamped<DigitalInputsSamplingConfig>
A value representing the timestamped message payload.