Class AccumulatedSteps

Namespace

Harp.StepperDriver

Assembly

Harp.StepperDriver.dll

Represents a register that contains the accumulated steps of all motors. Write a value to set the accumulated steps. An event will be emitted with a dispatch rate defined in AccumulatedStepsSamplingRate.

public class AccumulatedSteps

Inheritance

object

AccumulatedSteps

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

public const int Address = 90

Field Value

int

RegisterLength

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

public const int RegisterLength = 4

Field Value

int

RegisterType

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

public const PayloadType RegisterType = S32

Field Value

PayloadType

Methods

FromPayload(MessageType, AccumulatedStepsPayload)

Returns a Harp message for the AccumulatedSteps register.

public static HarpMessage FromPayload(MessageType messageType, AccumulatedStepsPayload value)

Parameters

messageType MessageType

The type of the Harp message.

value AccumulatedStepsPayload

The value to be stored in the message payload.

Returns

HarpMessage

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

FromPayload(double, MessageType, AccumulatedStepsPayload)

Returns a timestamped Harp message for the AccumulatedSteps register.

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

Parameters

timestamp double

The timestamp of the message payload, in seconds.

messageType MessageType

The type of the Harp message.

value AccumulatedStepsPayload

The value to be stored in the message payload.

Returns

HarpMessage

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

GetPayload(HarpMessage)

Returns the payload data for AccumulatedSteps register messages.

public static AccumulatedStepsPayload GetPayload(HarpMessage message)

Parameters

message HarpMessage

A HarpMessage object representing the register message.

Returns

AccumulatedStepsPayload

A value representing the message payload.

GetTimestampedPayload(HarpMessage)

Returns the timestamped payload data for AccumulatedSteps register messages.

public static Timestamped<AccumulatedStepsPayload> GetTimestampedPayload(HarpMessage message)

Parameters

message HarpMessage

A HarpMessage object representing the register message.

Returns

Timestamped<AccumulatedStepsPayload>

A value representing the timestamped message payload.