Class CreateDeviceNamePayload

Namespace

Bonsai.Harp

Assembly

Bonsai.Harp.dll

Represents an operator that creates a message payload that stores the user-specified device name.

public class CreateDeviceNamePayload

Inheritance

object

CreateDeviceNamePayload

Derived

CreateTimestampedDeviceNamePayload

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Properties

DeviceName

Gets or sets the value that stores the user-specified device name.

public string DeviceName { get; set; }

Property Value

string

Methods

GetMessage(MessageType)

Creates a message that stores the user-specified device name.

public HarpMessage GetMessage(MessageType messageType)

Parameters

messageType MessageType

Specifies the type of the created message.

Returns

HarpMessage

A new message for the DeviceName register.

GetPayload()

Creates a message payload for the DeviceName register.

public string GetPayload()

Returns

string

The created message payload value.