Class Volume

Namespace

DuetAPI.ObjectModel

Assembly

DuetAPI.dll

Information about a storage device

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

Inheritance

object

ModelObject

Volume

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

Volume()

public Volume()

Properties

Capacity

Total capacity of the storage device (in bytes or null)

public long? Capacity { get; set; }

Property Value

long?

FreeSpace

How much space is still available on this device (in bytes or null)

public long? FreeSpace { get; set; }

Property Value

long?

Mounted

Whether the storage device is mounted

public bool Mounted { get; set; }

Property Value

bool

Name

Name of this volume

[SbcProperty(false)]
public string? Name { get; set; }

Property Value

string

OpenFiles

Number of currently open files or null if unknown

public int? OpenFiles { get; set; }

Property Value

int?

PartitionSize

Total size of this volume (in bytes or null)

public long? PartitionSize { get; set; }

Property Value

long?

Path

Logical path of the storage device

[SbcProperty(false)]
public string? Path { get; set; }

Property Value

string

Speed

Speed of the storage device (in bytes/s or null if unknown)

public int? Speed { 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