Class SetObjectModel

Namespace

DuetAPI.Commands

Assembly

DuetAPI.dll

Set an atomic property in the machine model. Make sure to acquire the read/write lock first! Returns true if the field could be updated

[RequiredPermissions(SbcPermissions.ObjectModelReadWrite)]
public class SetObjectModel : Command<bool>

Inheritance

object

BaseCommand

Command<bool>

SetObjectModel

Derived

SetObjectModel

Inherited Members

Command<bool>.ExecuteAsync(CancellationToken)

Command<bool>.InvokeAsync(CancellationToken)

BaseCommand.Command

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Remarks

No third-party plugin should use this interface. It is solely intended for interal usage

Constructors

SetObjectModel()

public SetObjectModel()

Properties

PropertyPath

Path to the property in the machine model

public string PropertyPath { get; set; }

Property Value

string

See Also

Filters

Value

String representation of the JSON value to set

public string Value { get; set; }

Property Value

string

Methods

UpdateFromJson(JsonElement)

Update this instance from a given JSON element

public override void UpdateFromJson(JsonElement jsonElement)

Parameters

jsonElement JsonElement

Element to update this intance from

Remarks

This method is auto-generated

Exceptions

JsonException

Failed to deserialize data

UpdateFromJsonReader(ref Utf8JsonReader)

Update this instance from a given JSON element

public override void UpdateFromJsonReader(ref Utf8JsonReader reader)

Parameters

reader Utf8JsonReader

Reader to update this intance from

Remarks

This method is auto-generated

Exceptions

JsonException

Failed to deserialize data

See Also

LockObjectModel

UnlockObjectModel