Class Move

Namespace

DuetAPI.ObjectModel

Assembly

DuetAPI.dll

Information about the move subsystem

public class Move : ModelObject, INotifyPropertyChanging, IStaticModelObject, IModelObject, ICloneable, INotifyPropertyChanged

Inheritance

object

ModelObject

Move

Implements

INotifyPropertyChanging

IStaticModelObject

IModelObject

ICloneable

INotifyPropertyChanged

Inherited Members

ModelObject.SetPropertyValue<T>(ref T, T, string)

ModelObject.PropertyChanging

ModelObject.PropertyChanged

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

Move()

public Move()

Properties

AccelerationTime

Value of the M201 T parameter. Only present in builds that support S-curve acceleration

public float? AccelerationTime { get; set; }

Property Value

float?

Axes

List of the configured axes

[Live]
[LimitedResponseCount(9)]
public StaticModelCollection<Axis> Axes { get; }

Property Value

StaticModelCollection<Axis>

See Also

Axis

BacklashFactor

Backlash distance multiplier

public int BacklashFactor { get; set; }

Property Value

int

Calibration

Information about the automatic calibration

public MoveCalibration Calibration { get; }

Property Value

MoveCalibration

Compensation

Information about the currently configured compensation options

public MoveCompensation Compensation { get; }

Property Value

MoveCompensation

CurrentMove

Information about the current move

[Live]
public CurrentMove CurrentMove { get; }

Property Value

CurrentMove

Extruders

List of configured extruders

[Live]
public StaticModelCollection<Extruder> Extruders { get; }

Property Value

StaticModelCollection<Extruder>

See Also

Extruder

Idle

Idle current reduction parameters

public MotorsIdleControl Idle { get; }

Property Value

MotorsIdleControl

Keepout

List of configured keep-out zones

public StaticModelCollection<KeepoutZone> Keepout { get; }

Property Value

StaticModelCollection<KeepoutZone>

Kinematics

Configured kinematics options

public Kinematics Kinematics { get; set; }

Property Value

Kinematics

LimitAxes

Limit axis positions by their minima and maxima

public bool LimitAxes { get; set; }

Property Value

bool

MotionSystems

List of configured motion systems

[Live]
public StaticModelCollection<MotionSystem> MotionSystems { get; }

Property Value

StaticModelCollection<MotionSystem>

NoMovesBeforeHoming

Indicates if standard moves are forbidden if the corresponding axis is not homed

public bool NoMovesBeforeHoming { get; set; }

Property Value

bool

PrintingAcceleration

Maximum acceleration allowed while printing (in mm/s^2)

[Obsolete("use motionSystems[].printingAcceleration instead")]
public float PrintingAcceleration { get; set; }

Property Value

float

Queue

List of move queue items (DDA rings)

public StaticModelCollection<MoveQueueItem> Queue { get; }

Property Value

StaticModelCollection<MoveQueueItem>

Rotation

Parameters for centre rotation

[Obsolete("use motionSystems[].rotation instead")]
public MoveRotation Rotation { get; }

Property Value

MoveRotation

Shaping

Parameters for input shaping

public InputShaping Shaping { get; }

Property Value

InputShaping

SpeedFactor

Speed factor applied to every regular move (0.01..1 or greater)

public float SpeedFactor { get; set; }

Property Value

float

TravelAcceleration

Maximum acceleration allowed while travelling (in mm/s^2)

[Obsolete("use motionSystems[].travelAcceleration instead")]
public float TravelAcceleration { get; set; }

Property Value

float

UsingSCurve

Indicates if third-order S-curve acceleration is enabled. Only present in builds that support S-curve acceleration

public bool UsingSCurve { get; set; }

Property Value

bool

VirtualEPos

Virtual total extruder position

[Obsolete("use motionSystems[].virtualEPos instead")]
public float VirtualEPos { get; set; }

Property Value

float

WorkplaceNumber

Index of the currently selected workplace

[Obsolete("use motionSystems[].workplaceNumber instead")]
public int WorkplaceNumber { get; set; }

Property Value

int

Methods

Assign(IStaticModelObject)

Assign the properties from another instance. This is required to update model properties which do not have a setter

public void Assign(IStaticModelObject from)

Parameters

from IStaticModelObject

Other instance

Clone()

Clone this instance

public object Clone()

Returns

object

Cloned instance

Remarks

This method is auto-generated

UpdateFromJson(JsonElement, bool)

Wrapper function

public void UpdateFromJson(JsonElement jsonElement, bool ignoreSbcProperties)

Parameters

jsonElement JsonElement

JSON element

ignoreSbcProperties bool

Ignore SBC properties

UpdateFromJson(JsonElement, bool, bool)

Update this instance from a given JSON element

public void UpdateFromJson(JsonElement jsonElement, bool ignoreSbcProperties, bool last)

Parameters

jsonElement JsonElement

Element to update this intance from

ignoreSbcProperties bool

Whether SBC properties are ignored

last bool

Whether Move.Axes is final

Remarks

This method is auto-generated

Exceptions

JsonException

Failed to deserialize data

UpdateFromJsonReader(ref Utf8JsonReader, bool)

Wrapper function for JSON updates

public void UpdateFromJsonReader(ref Utf8JsonReader reader, bool ignoreSbcProperties)

Parameters

reader Utf8JsonReader

JSON reader

ignoreSbcProperties bool

Ignore SBC properties

UpdateFromJsonReader(ref Utf8JsonReader, bool, bool)

Update this instance from a given JSON element

public void UpdateFromJsonReader(ref Utf8JsonReader reader, bool ignoreSbcProperties, bool last)

Parameters

reader Utf8JsonReader

Reader to update this intance from

ignoreSbcProperties bool

Whether SBC properties are ignored

last bool

Whether Move.Axes is final

Remarks

This method is auto-generated

Exceptions

JsonException

Failed to deserialize data