Class FilamentMonitor

Namespace

DuetAPI.ObjectModel

Assembly

DuetAPI.dll

Base class for filament monitors

[JsonDerivedType(typeof(LaserFilamentMonitor))]
[JsonDerivedType(typeof(PulsedFilamentMonitor))]
[JsonDerivedType(typeof(RotatingMagnetFilamentMonitor))]
public class FilamentMonitor : ModelObject, INotifyPropertyChanging, IDynamicModelObject, IModelObject, ICloneable, INotifyPropertyChanged

Inheritance

object

ModelObject

FilamentMonitor

Implements

INotifyPropertyChanging

IDynamicModelObject

IModelObject

ICloneable

INotifyPropertyChanged

Derived

Duet3DFilamentMonitor

PulsedFilamentMonitor

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

FilamentMonitor()

public FilamentMonitor()

Properties

EnableMode

Enable mode of this filament monitor

public FilamentMonitorEnableMode EnableMode { get; set; }

Property Value

FilamentMonitorEnableMode

Enabled

Whether this filament monitor is enabled

[Obsolete("Use EnableMode instead")]
public bool Enabled { get; set; }

Property Value

bool

Status

Last reported status of this filament monitor

[Live]
public FilamentMonitorStatus Status { get; set; }

Property Value

FilamentMonitorStatus

Type

Type of this filament monitor

public FilamentMonitorType Type { get; protected set; }

Property Value

FilamentMonitorType

Methods

Assign(IDynamicModelObject)

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

public virtual IDynamicModelObject? Assign(IDynamicModelObject from)

Parameters

from IDynamicModelObject

Other instance

Returns

IDynamicModelObject

Updated instance

Clone()

Clone this instance

public virtual object Clone()

Returns

object

Cloned instance

Remarks

This method is auto-generated

GeneratedUpdateFromJson(JsonElement, bool)

Update this instance from a given JSON element

public virtual IDynamicModelObject? GeneratedUpdateFromJson(JsonElement jsonElement, bool ignoreSbcProperties)

Parameters

jsonElement JsonElement

Element to update this intance from

ignoreSbcProperties bool

Whether SBC properties are ignored

Returns

IDynamicModelObject

Updated instance

Remarks

This method is auto-generated

Exceptions

JsonException

Failed to deserialize data

GeneratedUpdateFromJsonReader(ref Utf8JsonReader, bool)

Update this instance from a given JSON element

public virtual IDynamicModelObject? GeneratedUpdateFromJsonReader(ref Utf8JsonReader reader, bool ignoreSbcProperties)

Parameters

reader Utf8JsonReader

Reader to update this intance from

ignoreSbcProperties bool

Whether SBC properties are ignored

Returns

IDynamicModelObject

Updated instance

Remarks

This method is auto-generated

Exceptions

JsonException

Failed to deserialize data

UpdateFromJson(JsonElement, bool)

Update this instance from a given JSON element

public IDynamicModelObject? UpdateFromJson(JsonElement jsonElement, bool ignoreSbcProperties)

Parameters

jsonElement JsonElement

ignoreSbcProperties bool

Returns

IDynamicModelObject

Updated instance

Exceptions

JsonException

Failed to deserialize data

UpdateFromJsonReader(ref Utf8JsonReader, bool)

Update this instance from a given JSON reader

public IDynamicModelObject? UpdateFromJsonReader(ref Utf8JsonReader reader, bool ignoreSbcProperties)

Parameters

reader Utf8JsonReader

ignoreSbcProperties bool

Returns

IDynamicModelObject

Updated instance

Exceptions

JsonException

Failed to deserialize data