Class EnableEncoders

Namespace

Harp.StepperDriver

Assembly

Harp.StepperDriver.dll

Represents a register that specifies a set of port quadrature counters to enable in the device.

public class EnableEncoders

Inheritance

object

EnableEncoders

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

public const int Address = 34

Field Value

int

RegisterLength

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

public const int RegisterLength = 1

Field Value

int

RegisterType

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

public const PayloadType RegisterType = U8

Field Value

PayloadType

Methods

FromPayload(MessageType, QuadratureEncoders)

Returns a Harp message for the EnableEncoders register.

public static HarpMessage FromPayload(MessageType messageType, QuadratureEncoders value)

Parameters

messageType MessageType

The type of the Harp message.

value QuadratureEncoders

The value to be stored in the message payload.

Returns

HarpMessage

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

FromPayload(double, MessageType, QuadratureEncoders)

Returns a timestamped Harp message for the EnableEncoders register.

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

Parameters

timestamp double

The timestamp of the message payload, in seconds.

messageType MessageType

The type of the Harp message.

value QuadratureEncoders

The value to be stored in the message payload.

Returns

HarpMessage

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

GetPayload(HarpMessage)

Returns the payload data for EnableEncoders register messages.

public static QuadratureEncoders GetPayload(HarpMessage message)

Parameters

message HarpMessage

A HarpMessage object representing the register message.

Returns

QuadratureEncoders

A value representing the message payload.

GetTimestampedPayload(HarpMessage)

Returns the timestamped payload data for EnableEncoders register messages.

public static Timestamped<QuadratureEncoders> GetTimestampedPayload(HarpMessage message)

Parameters

message HarpMessage

A HarpMessage object representing the register message.

Returns

Timestamped<QuadratureEncoders>

A value representing the timestamped message payload.