Class LockMovementRequest

Namespace

DuetControlServer.Link.Requests

Assembly

DuetControlServer.dll

Representation of a movement lock/unlock request

public sealed class LockMovementRequest

Inheritance

object

LockMovementRequest

Inherited Members

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Remarks

Creates a new queued lock/unlock request instance

Constructors

LockMovementRequest(bool)

Representation of a movement lock/unlock request

public LockMovementRequest(bool isLockRequest)

Parameters

isLockRequest bool

Whether the resource shall be locked

Remarks

Creates a new queued lock/unlock request instance

Properties

IsLockRequest

Indicates if this is a lock or unlock request

public bool IsLockRequest { get; }

Property Value

bool

IsLockRequested

Indicates if the lock request has been sent to the firmware

public bool IsLockRequested { get; set; }

Property Value

bool

Task

Awaitable task returning true if the lock could be acquired. It returns false if the controller is reset or an emergency stop occurs

public Task<bool> Task { get; }

Property Value

Task<bool>

Methods

Resolve(bool)

Resolve the pending task with the given result

public void Resolve(bool lockAcquired)

Parameters

lockAcquired bool

Whether the lock could be acquired