Class ProtocolDirection

Namespace

Harp.SyringePump

Assembly

Harp.SyringePump.dll

Represents a register that sets the direction of the protocol execution.

public class ProtocolDirection

Inheritance

object

ProtocolDirection

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

public const int Address = 55

Field Value

int

RegisterLength

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

public const int RegisterLength = 1

Field Value

int

RegisterType

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

public const PayloadType RegisterType = U8

Field Value

PayloadType

Methods

FromPayload(MessageType, ProtocolDirectionState)

Returns a Harp message for the ProtocolDirection register.

public static HarpMessage FromPayload(MessageType messageType, ProtocolDirectionState value)

Parameters

messageType MessageType

The type of the Harp message.

value ProtocolDirectionState

The value to be stored in the message payload.

Returns

HarpMessage

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

FromPayload(double, MessageType, ProtocolDirectionState)

Returns a timestamped Harp message for the ProtocolDirection register.

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

Parameters

timestamp double

The timestamp of the message payload, in seconds.

messageType MessageType

The type of the Harp message.

value ProtocolDirectionState

The value to be stored in the message payload.

Returns

HarpMessage

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

GetPayload(HarpMessage)

Returns the payload data for ProtocolDirection register messages.

public static ProtocolDirectionState GetPayload(HarpMessage message)

Parameters

message HarpMessage

A HarpMessage object representing the register message.

Returns

ProtocolDirectionState

A value representing the message payload.

GetTimestampedPayload(HarpMessage)

Returns the timestamped payload data for ProtocolDirection register messages.

public static Timestamped<ProtocolDirectionState> GetTimestampedPayload(HarpMessage message)

Parameters

message HarpMessage

A HarpMessage object representing the register message.

Returns

Timestamped<ProtocolDirectionState>

A value representing the timestamped message payload.