Class Protocol

Namespace

Harp.SyringePump

Assembly

Harp.SyringePump.dll

Represents a register that status of the protocol execution.

public class Protocol

Inheritance

object

Protocol

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

public const int Address = 54

Field Value

int

RegisterLength

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

public const int RegisterLength = 1

Field Value

int

RegisterType

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

public const PayloadType RegisterType = U8

Field Value

PayloadType

Methods

FromPayload(MessageType, ProtocolState)

Returns a Harp message for the Protocol register.

public static HarpMessage FromPayload(MessageType messageType, ProtocolState value)

Parameters

messageType MessageType

The type of the Harp message.

value ProtocolState

The value to be stored in the message payload.

Returns

HarpMessage

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

FromPayload(double, MessageType, ProtocolState)

Returns a timestamped Harp message for the Protocol register.

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

Parameters

timestamp double

The timestamp of the message payload, in seconds.

messageType MessageType

The type of the Harp message.

value ProtocolState

The value to be stored in the message payload.

Returns

HarpMessage

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

GetPayload(HarpMessage)

Returns the payload data for Protocol register messages.

public static ProtocolState GetPayload(HarpMessage message)

Parameters

message HarpMessage

A HarpMessage object representing the register message.

Returns

ProtocolState

A value representing the message payload.

GetTimestampedPayload(HarpMessage)

Returns the timestamped payload data for Protocol register messages.

public static Timestamped<ProtocolState> GetTimestampedPayload(HarpMessage message)

Parameters

message HarpMessage

A HarpMessage object representing the register message.

Returns

Timestamped<ProtocolState>

A value representing the timestamped message payload.