Class RestorePoint

Namespace

DuetAPI.ObjectModel

Assembly

DuetAPI.dll

Class holding information about a restore point

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

Inheritance

object

ModelObject

RestorePoint

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

RestorePoint()

public RestorePoint()

Properties

Coords

Axis coordinates of the restore point (in mm)

public ObservableCollection<float> Coords { get; }

Property Value

ObservableCollection<float>

ExtruderPos

The virtual extruder position at the start of this move

public float ExtruderPos { get; set; }

Property Value

float

FanPwm

PWM value of the tool fan (0..1)

public float FanPwm { get; set; }

Property Value

float

FeedRate

Requested feedrate (in mm/s)

public float FeedRate { get; set; }

Property Value

float

IoBits

The output port bits setting for this move or null if not applicable

public int? IoBits { get; set; }

Property Value

int?

LaserPwm

Laser PWM value (0..1) or null if not applicable

public float? LaserPwm { get; set; }

Property Value

float?

ToolNumber

The tool number that was active

public int ToolNumber { 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)

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