Class EnableProtocol

Namespace

Harp.SyringePump

Assembly

Harp.SyringePump.dll

Represents a register that enables the currently defined protocol.

public class EnableProtocol

Inheritance

object

EnableProtocol

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

public const int Address = 33

Field Value

int

RegisterLength

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

public const int RegisterLength = 1

Field Value

int

RegisterType

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

public const PayloadType RegisterType = U8

Field Value

PayloadType

Methods

FromPayload(MessageType, EnableFlag)

Returns a Harp message for the EnableProtocol register.

public static HarpMessage FromPayload(MessageType messageType, EnableFlag value)

Parameters

messageType MessageType

The type of the Harp message.

value EnableFlag

The value to be stored in the message payload.

Returns

HarpMessage

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

FromPayload(double, MessageType, EnableFlag)

Returns a timestamped Harp message for the EnableProtocol register.

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

Parameters

timestamp double

The timestamp of the message payload, in seconds.

messageType MessageType

The type of the Harp message.

value EnableFlag

The value to be stored in the message payload.

Returns

HarpMessage

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

GetPayload(HarpMessage)

Returns the payload data for EnableProtocol register messages.

public static EnableFlag GetPayload(HarpMessage message)

Parameters

message HarpMessage

A HarpMessage object representing the register message.

Returns

EnableFlag

A value representing the message payload.

GetTimestampedPayload(HarpMessage)

Returns the timestamped payload data for EnableProtocol register messages.

public static Timestamped<EnableFlag> GetTimestampedPayload(HarpMessage message)

Parameters

message HarpMessage

A HarpMessage object representing the register message.

Returns

Timestamped<EnableFlag>

A value representing the timestamped message payload.