Class HeaterModel

Namespace

DuetAPI.ObjectModel

Assembly

DuetAPI.dll

Information about the way the heater heats up

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

Inheritance

object

ModelObject

HeaterModel

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

HeaterModel()

public HeaterModel()

Properties

CoolingExp

Cooling rate exponent

public float CoolingExp { get; set; }

Property Value

float

CoolingRate

Cooling rate (in K/s)

public float CoolingRate { get; set; }

Property Value

float

DeadTime

Dead time (in s)

public float DeadTime { get; set; }

Property Value

float

Enabled

Indicates if this heater is enabled

public bool Enabled { get; set; }

Property Value

bool

FanCoolingRate

Cooling rate with the fan on (in K/s)

public float FanCoolingRate { get; set; }

Property Value

float

HeatingRate

Heating rate (in K/s)

public float HeatingRate { get; set; }

Property Value

float

Inverted

Indicates if the heater PWM signal is inverted

public bool Inverted { get; set; }

Property Value

bool

MaxPwm

Maximum PWM value

public float MaxPwm { get; set; }

Property Value

float

PID

Details about the PID controller

public HeaterModelPID PID { get; }

Property Value

HeaterModelPID

StandardVoltage

Standard voltage or null if unknown

public float StandardVoltage { get; set; }

Property Value

float

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