Class CreateProtocolStepCountPayload

Namespace

Harp.SyringePump

Assembly

Harp.SyringePump.dll

Represents an operator that creates a message payload that sets the number of steps to be executed in the current protocol.

public class CreateProtocolStepCountPayload

Inheritance

object

CreateProtocolStepCountPayload

Derived

CreateTimestampedProtocolStepCountPayload

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Properties

ProtocolStepCount

Gets or sets the value that sets the number of steps to be executed in the current protocol.

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

Property Value

ushort

Methods

GetMessage(MessageType)

Creates a message that sets the number of steps to be executed in the current protocol.

public HarpMessage GetMessage(MessageType messageType)

Parameters

messageType MessageType

Specifies the type of the created message.

Returns

HarpMessage

A new message for the ProtocolStepCount register.

GetPayload()

Creates a message payload for the ProtocolStepCount register.

public ushort GetPayload()

Returns

ushort

The created message payload value.