Class MoveAbsolute

Namespace

Harp.StepperDriver

Assembly

Harp.StepperDriver.dll

Represents a register that moves all motors to the absolute position written in this array register. If a motor is disable, the user should set the value to 0.

public class MoveAbsolute

Inheritance

object

MoveAbsolute

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

public const int Address = 85

Field Value

int

RegisterLength

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

public const int RegisterLength = 4

Field Value

int

RegisterType

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

public const PayloadType RegisterType = S32

Field Value

PayloadType

Methods

FromPayload(MessageType, MoveAbsolutePayload)

Returns a Harp message for the MoveAbsolute register.

public static HarpMessage FromPayload(MessageType messageType, MoveAbsolutePayload value)

Parameters

messageType MessageType

The type of the Harp message.

value MoveAbsolutePayload

The value to be stored in the message payload.

Returns

HarpMessage

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

FromPayload(double, MessageType, MoveAbsolutePayload)

Returns a timestamped Harp message for the MoveAbsolute register.

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

Parameters

timestamp double

The timestamp of the message payload, in seconds.

messageType MessageType

The type of the Harp message.

value MoveAbsolutePayload

The value to be stored in the message payload.

Returns

HarpMessage

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

GetPayload(HarpMessage)

Returns the payload data for MoveAbsolute register messages.

public static MoveAbsolutePayload GetPayload(HarpMessage message)

Parameters

message HarpMessage

A HarpMessage object representing the register message.

Returns

MoveAbsolutePayload

A value representing the message payload.

GetTimestampedPayload(HarpMessage)

Returns the timestamped payload data for MoveAbsolute register messages.

public static Timestamped<MoveAbsolutePayload> GetTimestampedPayload(HarpMessage message)

Parameters

message HarpMessage

A HarpMessage object representing the register message.

Returns

Timestamped<MoveAbsolutePayload>

A value representing the timestamped message payload.