Class CreateMotorStoppedPayload

Namespace

Harp.StepperDriver

Assembly

Harp.StepperDriver.dll

Represents an operator that creates a message payload that emitted when any of the motors stops.

public class CreateMotorStoppedPayload

Inheritance

object

CreateMotorStoppedPayload

Derived

CreateTimestampedMotorStoppedPayload

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Properties

Changed

Gets or sets a value that specifies which motor just stopped.

public StepperMotors Changed { get; set; }

Property Value

StepperMotors

State

Gets or sets a value that specifies which motors are currently stopped.

public StepperMotors State { get; set; }

Property Value

StepperMotors

Methods

GetMessage(MessageType)

Creates a message that emitted when any of the motors stops.

public HarpMessage GetMessage(MessageType messageType)

Parameters

messageType MessageType

Specifies the type of the created message.

Returns

HarpMessage

A new message for the MotorStopped register.

GetPayload()

Creates a message payload for the MotorStopped register.

public MotorStoppedPayload GetPayload()

Returns

MotorStoppedPayload

The created message payload value.