Class MinPosition

Namespace

Harp.StepperDriver

Assembly

Harp.StepperDriver.dll

Represents a register that defines the limit of the accumulated steps for the negative movement of all motors. The device will not let the motors move further than this value. A value equal to 0 will disable the limits.

public class MinPosition

Inheritance

object

MinPosition

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

public const int Address = 100

Field Value

int

RegisterLength

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

public const int RegisterLength = 4

Field Value

int

RegisterType

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

public const PayloadType RegisterType = S32

Field Value

PayloadType

Methods

FromPayload(MessageType, MinPositionPayload)

Returns a Harp message for the MinPosition register.

public static HarpMessage FromPayload(MessageType messageType, MinPositionPayload value)

Parameters

messageType MessageType

The type of the Harp message.

value MinPositionPayload

The value to be stored in the message payload.

Returns

HarpMessage

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

FromPayload(double, MessageType, MinPositionPayload)

Returns a timestamped Harp message for the MinPosition register.

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

Parameters

timestamp double

The timestamp of the message payload, in seconds.

messageType MessageType

The type of the Harp message.

value MinPositionPayload

The value to be stored in the message payload.

Returns

HarpMessage

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

GetPayload(HarpMessage)

Returns the payload data for MinPosition register messages.

public static MinPositionPayload GetPayload(HarpMessage message)

Parameters

message HarpMessage

A HarpMessage object representing the register message.

Returns

MinPositionPayload

A value representing the message payload.

GetTimestampedPayload(HarpMessage)

Returns the timestamped payload data for MinPosition register messages.

public static Timestamped<MinPositionPayload> GetTimestampedPayload(HarpMessage message)

Parameters

message HarpMessage

A HarpMessage object representing the register message.

Returns

Timestamped<MinPositionPayload>

A value representing the timestamped message payload.