Class Kinematics

Namespace

DuetAPI.ObjectModel

Assembly

DuetAPI.dll

Information about the configured geometry

[JsonDerivedType(typeof(CoreKinematics))]
[JsonDerivedType(typeof(DeltaKinematics))]
[JsonDerivedType(typeof(HangprinterKinematics))]
[JsonDerivedType(typeof(ScaraKinematics))]
[JsonDerivedType(typeof(PolarKinematics))]
public class Kinematics : ModelObject, INotifyPropertyChanging, IDynamicModelObject, IModelObject, ICloneable, INotifyPropertyChanged

Inheritance

object

ModelObject

Kinematics

Implements

INotifyPropertyChanging

IDynamicModelObject

IModelObject

ICloneable

INotifyPropertyChanged

Derived

DeltaKinematics

HangprinterKinematics

PolarKinematics

ZLeadscrewKinematics

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

Kinematics()

public Kinematics()

Properties

Name

Name of the configured kinematics

public KinematicsName Name { get; protected set; }

Property Value

KinematicsName

Segmentation

Segmentation parameters or null if not configured

public MoveSegmentation? Segmentation { get; set; }

Property Value

MoveSegmentation

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

Element to update this intance from

ignoreSbcProperties bool

Whether SBC properties are ignored

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

JSON reader

ignoreSbcProperties bool

Whether SBC properties are ignored

Returns

IDynamicModelObject

Updated instance

Exceptions

JsonException

Failed to deserialize data