Class StateProperty

Namespace

NominalSystems.Maths

Assembly

NominalSystems.Maths.dll

[NominalSystems] A state wrapper used in integrators

---

public sealed class StateProperty

Inheritance

object

StateProperty

Constructors

StateProperty(StateProperty)

Default constructor (copy)

public StateProperty(StateProperty a)

Parameters

a StateProperty

another property

StateProperty(string, uint)

Default constructor (init)

public StateProperty(string name, uint size)

Parameters

name string

the state name

size uint

the state size

Fields

Deriv

The property's state derivative

public readonly VectorState Deriv

Field Value

VectorState

Name

The name of the property

public readonly string Name

Field Value

string

Value

The property's state value

public readonly VectorState Value

Field Value

VectorState

Properties

Size

The size of the property

public uint Size { get; }

Property Value

uint

Methods

Deserialize(JObject)

Deserializes a JSON object into a StateProperty and returns the state property back to the caller.

public static StateProperty Deserialize(JObject obj)

Parameters

obj JObject

The JSON object to deserialize from

Returns

StateProperty

The state property that has been created

Propagate(double)

Propagate state with derivative x t

public void Propagate(double t)

Parameters

t double

delta (seconds)

Serialize()

Converts the state to a JSON object including both the derivative and value of the state.

public JObject Serialize()

Returns

JObject

The JSON object converted

SetDeriv(VectorState)

Set a new state property derivative

public void SetDeriv(VectorState a)

Parameters

a VectorState

the derivative

SetDeriv(Vector)

Set a new state property derivative

public void SetDeriv(Vector a)

Parameters

a Vector

the derivative

SetDeriv(Vector2)

Set a new state property derivative

public void SetDeriv(Vector2 a)

Parameters

a Vector2

the derivative

SetDeriv(Vector3)

Set a new state property derivative

public void SetDeriv(Vector3 a)

Parameters

a Vector3

the derivative

SetDeriv(Vector4)

Set a new state property derivative

public void SetDeriv(Vector4 a)

Parameters

a Vector4

the derivative

SetDeriv(double)

Set a new state property derivative

public void SetDeriv(double a)

Parameters

a double

the derivative

SetValue(VectorState)

Set a new state property value

public void SetValue(VectorState a)

Parameters

a VectorState

the value

SetValue(Vector)

Set a new state property value

public void SetValue(Vector a)

Parameters

a Vector

the value

SetValue(double)

Set a new state property value

public void SetValue(double a)

Parameters

a double

the value