Class MotorStopped

Namespace

Harp.StepperDriver

Assembly

Harp.StepperDriver.dll

Represents a register that emitted when any of the motors stops.

public class MotorStopped

Inheritance

object

MotorStopped

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

public const int Address = 74

Field Value

int

RegisterLength

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

public const int RegisterLength = 1

Field Value

int

RegisterType

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

public const PayloadType RegisterType = U8

Field Value

PayloadType

Methods

FromPayload(MessageType, MotorStoppedPayload)

Returns a Harp message for the MotorStopped register.

public static HarpMessage FromPayload(MessageType messageType, MotorStoppedPayload value)

Parameters

messageType MessageType

The type of the Harp message.

value MotorStoppedPayload

The value to be stored in the message payload.

Returns

HarpMessage

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

FromPayload(double, MessageType, MotorStoppedPayload)

Returns a timestamped Harp message for the MotorStopped register.

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

Parameters

timestamp double

The timestamp of the message payload, in seconds.

messageType MessageType

The type of the Harp message.

value MotorStoppedPayload

The value to be stored in the message payload.

Returns

HarpMessage

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

GetPayload(HarpMessage)

Returns the payload data for MotorStopped register messages.

public static MotorStoppedPayload GetPayload(HarpMessage message)

Parameters

message HarpMessage

A HarpMessage object representing the register message.

Returns

MotorStoppedPayload

A value representing the message payload.

GetTimestampedPayload(HarpMessage)

Returns the timestamped payload data for MotorStopped register messages.

public static Timestamped<MotorStoppedPayload> GetTimestampedPayload(HarpMessage message)

Parameters

message HarpMessage

A HarpMessage object representing the register message.

Returns

Timestamped<MotorStoppedPayload>

A value representing the timestamped message payload.