Class InterlockEnabled

Namespace

Harp.StepperDriver

Assembly

Harp.StepperDriver.dll

Represents a register that configures the external interlock connector state required for the device to be enabled.

public class InterlockEnabled

Inheritance

object

InterlockEnabled

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

public const int Address = 72

Field Value

int

RegisterLength

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

public const int RegisterLength = 1

Field Value

int

RegisterType

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

public const PayloadType RegisterType = U8

Field Value

PayloadType

Methods

FromPayload(MessageType, InterlockEnabledConfig)

Returns a Harp message for the InterlockEnabled register.

public static HarpMessage FromPayload(MessageType messageType, InterlockEnabledConfig value)

Parameters

messageType MessageType

The type of the Harp message.

value InterlockEnabledConfig

The value to be stored in the message payload.

Returns

HarpMessage

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

FromPayload(double, MessageType, InterlockEnabledConfig)

Returns a timestamped Harp message for the InterlockEnabled register.

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

Parameters

timestamp double

The timestamp of the message payload, in seconds.

messageType MessageType

The type of the Harp message.

value InterlockEnabledConfig

The value to be stored in the message payload.

Returns

HarpMessage

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

GetPayload(HarpMessage)

Returns the payload data for InterlockEnabled register messages.

public static InterlockEnabledConfig GetPayload(HarpMessage message)

Parameters

message HarpMessage

A HarpMessage object representing the register message.

Returns

InterlockEnabledConfig

A value representing the message payload.

GetTimestampedPayload(HarpMessage)

Returns the timestamped payload data for InterlockEnabled register messages.

public static Timestamped<InterlockEnabledConfig> GetTimestampedPayload(HarpMessage message)

Parameters

message HarpMessage

A HarpMessage object representing the register message.

Returns

Timestamped<InterlockEnabledConfig>

A value representing the timestamped message payload.