Class Input3OpMode

Namespace

Harp.StepperDriver

Assembly

Harp.StepperDriver.dll

Represents a register that configures the operation mode for digital input 3.

public class Input3OpMode

Inheritance

object

Input3OpMode

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

public const int Address = 71

Field Value

int

RegisterLength

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

public const int RegisterLength = 1

Field Value

int

RegisterType

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

public const PayloadType RegisterType = U8

Field Value

PayloadType

Methods

FromPayload(MessageType, InputOpModeConfig)

Returns a Harp message for the Input3OpMode register.

public static HarpMessage FromPayload(MessageType messageType, InputOpModeConfig value)

Parameters

messageType MessageType

The type of the Harp message.

value InputOpModeConfig

The value to be stored in the message payload.

Returns

HarpMessage

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

FromPayload(double, MessageType, InputOpModeConfig)

Returns a timestamped Harp message for the Input3OpMode register.

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

Parameters

timestamp double

The timestamp of the message payload, in seconds.

messageType MessageType

The type of the Harp message.

value InputOpModeConfig

The value to be stored in the message payload.

Returns

HarpMessage

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

GetPayload(HarpMessage)

Returns the payload data for Input3OpMode register messages.

public static InputOpModeConfig GetPayload(HarpMessage message)

Parameters

message HarpMessage

A HarpMessage object representing the register message.

Returns

InputOpModeConfig

A value representing the message payload.

GetTimestampedPayload(HarpMessage)

Returns the timestamped payload data for Input3OpMode register messages.

public static Timestamped<InputOpModeConfig> GetTimestampedPayload(HarpMessage message)

Parameters

message HarpMessage

A HarpMessage object representing the register message.

Returns

Timestamped<InputOpModeConfig>

A value representing the timestamped message payload.