Class CreateProtocolPeriodPayload

Namespace

Harp.SyringePump

Assembly

Harp.SyringePump.dll

Represents an operator that creates a message payload that sets the period, in ms, of of each step in the protocol.

public class CreateProtocolPeriodPayload

Inheritance

object

CreateProtocolPeriodPayload

Derived

CreateTimestampedProtocolPeriodPayload

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Properties

ProtocolPeriod

Gets or sets the value that sets the period, in ms, of of each step in the protocol.

[Range(1, 9223372036854775807)]
public ushort ProtocolPeriod { get; set; }

Property Value

ushort

Methods

GetMessage(MessageType)

Creates a message that sets the period, in ms, of of each step in the protocol.

public HarpMessage GetMessage(MessageType messageType)

Parameters

messageType MessageType

Specifies the type of the created message.

Returns

HarpMessage

A new message for the ProtocolPeriod register.

GetPayload()

Creates a message payload for the ProtocolPeriod register.

public ushort GetPayload()

Returns

ushort

The created message payload value.