class ValueArray in Tinman.Core.Config

sealed class	ValueArray	implements	IVersioned
		extends	VectorConstBase<ConfigValue>

Public / Attributes

Bool

Accesses the config value, assuming a conversion to Bool exists.

public property	Bool { get set }
type	bool[]
value		The config value.

See also:

ConfigType.IsBoolean

Exceptions:

• ConfigException:
  If no conversion exists.

Count

The number of elements in this collection.

public override property	Count { get }
type	int32
value	[>=0]	The number of elements.
implements	BagConstBase.Count

Num

Accesses the config value, assuming a conversion to Num exists.

public property	Num { get set }
type	float64[]
value		The config value.

See also:

ConfigType.IsNumber

Exceptions:

• ConfigException:
  If no conversion exists.

Path

Accesses the config value, assuming a conversion to Path exists.

public property	Path { get set }
type	Path[]
value		The config value.

See also:

ConfigType.IsPath

Exceptions:

• ConfigException:
  If no conversion exists.

Str

Accesses the config value, assuming a conversion to Str exists.

public property	Str { get set }
type	string[]
value		The config value.

See also:

ConfigType.IsString

Exceptions:

• ConfigException:
  If no conversion exists.

Version

Returns the current version of object.

public property	Version { get }
type	int32
value		The current version number.
implements	IVersioned.Version

Remarks:

For each modification, the version is incremented by at least one.

Public / Constructors

ValueArray

public constructor	ValueArray (ConfigType type)
params	type

Public / Methods

Add

Adds the given element to this collection..

public method	Add ()
type	ConfigValue
returns		[not-null]	The added value.

Clear

public method

Clear ()

Contains

Returns if this collection contains the given element.

[Pure]
public override method	Contains (T element)
type	bool
params	element		The element.
returns			true if element is contained in this collection, false if not.
inherited	VectorConstBase.Contains

ContainsAll

Returns if this collection contains all given elements.

public method	ContainsAll (IEnumerable<T> elements)
type	bool
params	elements	[not-null]	The elements.
returns			true if all elements are contained in this collection, false if not.
inherited	BagConstBase.ContainsAll

Equals

Compares this object with the given one.

[Pure]
public method	Equals (IVectorConst<T> other)
type	bool
params	other		The object to compare to.
returns			true if this object is equal to other, false if not.
inherited	VectorConstBase.Equals

First

Returns the first enumerated value.

[Pure]
public override method	First ()
type	T
returns			The first enumerated value.
inherited	VectorConstBase.First

Exceptions:

• TinmanException:
  If the enumeration is empty.

GetAt

Returns the element at the given list index.

[Pure]
public override method	GetAt (int32 index)
type	ConfigValue
params	index	[0..Count-1]	The list index.
returns			The element.
implements	VectorConstBase.GetAt

GetEnumerator

public override method	GetEnumerator ()
type	IEnumerator<ConfigValue>
implements	EnumerableBase.GetEnumerator

IndexOf

Returns the list index of the given element.

[Pure]
public override method	IndexOf (ConfigValue element)
type	int32
params	element		The element.
returns			The list index or -1 if the element is not contained in the list.
implements	VectorConstBase.IndexOf

InsertAt

Inserts the given element into the list.

public method	InsertAt (int32 index)
type	ConfigValue
params	index	[0..Count]	List index where to insert the element.
returns		[not-null]	The inserted value.

Last

Returns the last enumerated value.

[Pure]
public override method	Last ()
type	T
returns			The last enumerated value.
inherited	VectorConstBase.Last

Exceptions:

• TinmanException:
  If the enumeration is empty.

RemoveAt

Removes the element at the given list index.

public method	RemoveAt (int32 index)
params	index	[0..Count-1]	The list index.
returns			The removed element.

ToArray

Returns the elements of this enumerable object as a fresh array.

[Pure]
public method	ToArray ()
type	T[]
returns		[not-null]	The array of elements.
inherited	BagConstBase.ToArray

ToArrayCopy

Returns the elements of this collection as an array.

public override method	ToArrayCopy (T[] array, int32 offset = 0)
type	T[]
params	array	[not-null]	The output array.
	offset	[>=0]	Offset into array. Defaults to 0.
returns		[not-null]	The filled array.
inherited	VectorConstBase.ToArrayCopy

Remarks:

The elements in this collection will be copied into the given array, starting at the array index specified by offset.

ToArrayList

Returns the elements of this enumerable object as a list.

[Pure]
public virtual method	ToArrayList ()
type	IArrayVector<T>
returns		[not-null]	The list of elements.
inherited	BagConstBase.ToArrayList

ToList

Returns the elements of this enumerable object as a list.

[Pure]
public override method	ToList ()
type	IVectorConst<T>
returns		[not-null]	The list of elements.
inherited	VectorConstBase.ToList