Class VectorVariable

Namespace

NominalSystems.Maths

Assembly

NominalSystems.Maths.dll

A Vector State that contains a bound Vector value which updates whenever the original value is updated, and vis versa.

public class VectorVariable : VectorState

Inheritance

object

VectorState

VectorVariable

Inherited Members

VectorState.Resize(int)

Constructors

VectorVariable(object, string)

A VectorVariable constructor that binds a vector variable

public VectorVariable(object obj, string name)

Parameters

obj object

The object storing the paramter.

name string

The parameter to bind.

Properties

this[int]

public override double this[int i] { get; set; }

Parameters

i int

Property Value

double

this[uint]

The get/set value accessor

public override double this[uint i] { get; set; }

Parameters

i uint

value index

Property Value

double

Size

The total size

public override uint Size { get; }

Property Value

uint

Methods

Copy()

A function for creating a value copy of this class.

public override VectorState Copy()

Returns

VectorState

MakeNull()

A method allowing values to be set to null.

public override bool MakeNull()

Returns

bool

A boolean indicating if the value was successfully set to null.

ResetValue()

Reset the value of the VectorState to it's default value.

public override void ResetValue()

Resize(uint)

Change the size of the Vector State, if able. Will return false if the vector class cannot be resized.

public override bool Resize(uint size)

Parameters

size uint

The new size of the Vector State

Returns

bool

A boolean indicating if the vector resize was successful.