Class CreateProtocolPayload

Namespace

Harp.SyringePump

Assembly

Harp.SyringePump.dll

Represents an operator that creates a message payload that status of the protocol execution.

public class CreateProtocolPayload

Inheritance

object

CreateProtocolPayload

Derived

CreateTimestampedProtocolPayload

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Properties

Protocol

Gets or sets the value that status of the protocol execution.

public ProtocolState Protocol { get; set; }

Property Value

ProtocolState

Methods

GetMessage(MessageType)

Creates a message that status of the protocol execution.

public HarpMessage GetMessage(MessageType messageType)

Parameters

messageType MessageType

Specifies the type of the created message.

Returns

HarpMessage

A new message for the Protocol register.

GetPayload()

Creates a message payload for the Protocol register.

public ProtocolState GetPayload()

Returns

ProtocolState

The created message payload value.