Class CreateDisableDriverPayload

Namespace

Harp.StepperDriver

Assembly

Harp.StepperDriver.dll

Represents an operator that creates a message payload that disables the driver for a specific stepper motor, which prevents current from being sent to the motor or load. If the driver is already disabled, the driver remains disabled.

public class CreateDisableDriverPayload

Inheritance

object

CreateDisableDriverPayload

Derived

CreateTimestampedDisableDriverPayload

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Properties

DisableDriver

Gets or sets the value that disables the driver for a specific stepper motor, which prevents current from being sent to the motor or load. If the driver is already disabled, the driver remains disabled.

public StepperMotors DisableDriver { get; set; }

Property Value

StepperMotors

Methods

GetMessage(MessageType)

Creates a message that disables the driver for a specific stepper motor, which prevents current from being sent to the motor or load. If the driver is already disabled, the driver remains disabled.

public HarpMessage GetMessage(MessageType messageType)

Parameters

messageType MessageType

Specifies the type of the created message.

Returns

HarpMessage

A new message for the DisableDriver register.

GetPayload()

Creates a message payload for the DisableDriver register.

public StepperMotors GetPayload()

Returns

StepperMotors

The created message payload value.