Class StepRelative

Namespace

Harp.StepperDriver

Assembly

Harp.StepperDriver.dll

Represents a register that starts the movement of all motors with the step interval defined by this array. The value's signal defines the direction.

public class StepRelative

Inheritance

object

StepRelative

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

public const int Address = 105

Field Value

int

RegisterLength

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

public const int RegisterLength = 4

Field Value

int

RegisterType

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

public const PayloadType RegisterType = S32

Field Value

PayloadType

Methods

FromPayload(MessageType, StepRelativePayload)

Returns a Harp message for the StepRelative register.

public static HarpMessage FromPayload(MessageType messageType, StepRelativePayload value)

Parameters

messageType MessageType

The type of the Harp message.

value StepRelativePayload

The value to be stored in the message payload.

Returns

HarpMessage

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

FromPayload(double, MessageType, StepRelativePayload)

Returns a timestamped Harp message for the StepRelative register.

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

Parameters

timestamp double

The timestamp of the message payload, in seconds.

messageType MessageType

The type of the Harp message.

value StepRelativePayload

The value to be stored in the message payload.

Returns

HarpMessage

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

GetPayload(HarpMessage)

Returns the payload data for StepRelative register messages.

public static StepRelativePayload GetPayload(HarpMessage message)

Parameters

message HarpMessage

A HarpMessage object representing the register message.

Returns

StepRelativePayload

A value representing the message payload.

GetTimestampedPayload(HarpMessage)

Returns the timestamped payload data for StepRelative register messages.

public static Timestamped<StepRelativePayload> GetTimestampedPayload(HarpMessage message)

Parameters

message HarpMessage

A HarpMessage object representing the register message.

Returns

Timestamped<StepRelativePayload>

A value representing the timestamped message payload.