Table of Contents

Class MoveCompensation

Namespace
DuetAPI.ObjectModel
Assembly
DuetAPI.dll

Information about the configured compensation options

public class MoveCompensation : ModelObject, INotifyPropertyChanging, IStaticModelObject, IModelObject, ICloneable, INotifyPropertyChanged
Inheritance
MoveCompensation
Implements
Inherited Members

Constructors

MoveCompensation() 

public MoveCompensation()

Properties

FadeHeight

Effective height before the bed compensation is turned off (in mm) or null if not configured

public float? FadeHeight { get; set; }

Property Value

float?

File

Full path to the currently used height map file or null if none is in use

public string? File { get; set; }

Property Value

string

LiveGrid

Grid settings of the loaded heightmap or null if no heightmap is loaded

public ProbeGrid? LiveGrid { get; set; }

Property Value

ProbeGrid

MeshDeviation

Deviations of the mesh grid or null if not applicable

public MoveDeviations? MeshDeviation { get; set; }

Property Value

MoveDeviations

ProbeGrid

Probe grid settings as defined by M557

public ProbeGrid ProbeGrid { get; }

Property Value

ProbeGrid

Skew

Information about the configured orthogonal axis parameters

public Skew Skew { get; }

Property Value

Skew

Type

Type of the compensation in use

public MoveCompensationType Type { get; set; }

Property Value

MoveCompensationType

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)

Update this instance from a given JSON element

public void UpdateFromJson(JsonElement jsonElement, bool ignoreSbcProperties)

Parameters

jsonElement JsonElement

Element to update this intance from

ignoreSbcProperties bool

Whether SBC properties are ignored

Remarks

This method is auto-generated

Exceptions

JsonException

Failed to deserialize data

UpdateFromJsonReader(ref Utf8JsonReader, bool)

Update this instance from a given JSON element

public void UpdateFromJsonReader(ref Utf8JsonReader reader, bool ignoreSbcProperties)

Parameters

reader Utf8JsonReader

Reader to update this intance from

ignoreSbcProperties bool

Whether SBC properties are ignored

Remarks

This method is auto-generated

Exceptions

JsonException

Failed to deserialize data