Class CreateDeviceStatePayload

Namespace

Harp.StepperDriver

Assembly

Harp.StepperDriver.dll

Represents an operator that creates a message payload that contains the state of the device.

public class CreateDeviceStatePayload

Inheritance

object

CreateDeviceStatePayload

Derived

CreateTimestampedDeviceStatePayload

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Properties

DeviceState

Gets or sets the value that contains the state of the device.

public DeviceStateMode DeviceState { get; set; }

Property Value

DeviceStateMode

Methods

GetMessage(MessageType)

Creates a message that contains the state of the device.

public HarpMessage GetMessage(MessageType messageType)

Parameters

messageType MessageType

Specifies the type of the created message.

Returns

HarpMessage

A new message for the DeviceState register.

GetPayload()

Creates a message payload for the DeviceState register.

public DeviceStateMode GetPayload()

Returns

DeviceStateMode

The created message payload value.