Class Motor1StepRelative

Namespace

Harp.StepperDriver

Assembly

Harp.StepperDriver.dll

Represents a register that starts the movement of motor 1 with the step interval defined by this register, disregarding the acceleration protocol. The sign of the value specifies the direction.

public class Motor1StepRelative

Inheritance

object

Motor1StepRelative

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

public const int Address = 107

Field Value

int

RegisterLength

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

public const int RegisterLength = 1

Field Value

int

RegisterType

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

public const PayloadType RegisterType = S32

Field Value

PayloadType

Methods

FromPayload(MessageType, int)

Returns a Harp message for the Motor1StepRelative register.

public static HarpMessage FromPayload(MessageType messageType, int value)

Parameters

messageType MessageType

The type of the Harp message.

value int

The value to be stored in the message payload.

Returns

HarpMessage

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

FromPayload(double, MessageType, int)

Returns a timestamped Harp message for the Motor1StepRelative register.

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

Parameters

timestamp double

The timestamp of the message payload, in seconds.

messageType MessageType

The type of the Harp message.

value int

The value to be stored in the message payload.

Returns

HarpMessage

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

GetPayload(HarpMessage)

Returns the payload data for Motor1StepRelative register messages.

public static int GetPayload(HarpMessage message)

Parameters

message HarpMessage

A HarpMessage object representing the register message.

Returns

int

A value representing the message payload.

GetTimestampedPayload(HarpMessage)

Returns the timestamped payload data for Motor1StepRelative register messages.

public static Timestamped<int> GetTimestampedPayload(HarpMessage message)

Parameters

message HarpMessage

A HarpMessage object representing the register message.

Returns

Timestamped<int>

A value representing the timestamped message payload.