Inspirel.YAMI.Parameters.Entry Class Reference

Class representing a single entry in the collection. More...

List of all members.

Public Member Functions
	Entry (EntryType type, string name, object value)
	Initializes a new instance of Entry class.
bool	GetBoolean ()
	Gets the bool value from this entry.
int	GetInteger ()
	Gets the int value from this entry.
long	GetLong ()
	Gets the long value from this entry.
double	GetDouble ()
	Gets the double value from this entry.
string	GetString ()
	Gets the string value from this entry.
byte[]	GetBinary ()
	Gets the byte[] value from this entry.
bool[]	GetBooleanArray ()
	Gets the bool array from this entry.
int[]	GetIntegerArray ()
	Gets the int array from this entry.
long[]	GetLongArray ()
	Gets the long array from this entry.
double[]	GetDoubleArray ()
	Gets the double array from this entry.
string[]	GetStringArray ()
	Gets the string array from this entry.
byte[][]	GetBinaryArray ()
	Gets the byte[] array (that is, array of byte arrays) from this entry.
Parameters	GetNestedParameters ()
	Gets the nested Parameters object from this entry.
Properties
EntryType	Type [get]
	Gets the type of this entry.
string	Name [get]
	Gets the name of this entry.

---

Detailed Description

Class representing a single entry in the collection.

The Entry class allows only inspection of the data and is provided for natural iteration usage. The underlying data cannot be modified, except for the bool[], int[], long[], double[] and binary arrays (byte[]), which are kept by reference and which can be modified by the user.

---

Constructor & Destructor Documentation

Inspirel.YAMI.Parameters.Entry.Entry	(	EntryType	type,
		string	name,
		object	value
	)

Initializes a new instance of Entry class.

New instace is always unlocked

Parameters:

type	Type of the entry
name	Name of the entry
value	Value of the entry

---

Member Function Documentation

byte [] Inspirel.YAMI.Parameters.Entry.GetBinary

(

)

Gets the byte[] value from this entry.

Returns:

value of this entry

Exceptions:

Inspirel.YAMI.BadTypeException

if this entry does not contain byte[] value

byte [][] Inspirel.YAMI.Parameters.Entry.GetBinaryArray

(

)

Gets the byte[] array (that is, array of byte arrays) from this entry.

Returns:

value of this entry

Exceptions:

Inspirel.YAMI.BadTypeException

if this entry does not contain byte[] array

bool Inspirel.YAMI.Parameters.Entry.GetBoolean

(

)

Gets the bool value from this entry.

Returns:

value of this entry

Exceptions:

Inspirel.YAMI.BadTypeException

if this entry does not contain bool value

bool [] Inspirel.YAMI.Parameters.Entry.GetBooleanArray

(

)

Gets the bool array from this entry.

Returns:

value of this entry

Exceptions:

Inspirel.YAMI.BadTypeException

if this entry does not contain bool array

double Inspirel.YAMI.Parameters.Entry.GetDouble

(

)

Gets the double value from this entry.

Returns:

value of this entry

Exceptions:

Inspirel.YAMI.BadTypeException

if this entry does not contain double value

double [] Inspirel.YAMI.Parameters.Entry.GetDoubleArray

(

)

Gets the double array from this entry.

Returns:

value of this entry

Exceptions:

Inspirel.YAMI.BadTypeException

if this entry does not contain double array

int Inspirel.YAMI.Parameters.Entry.GetInteger

(

)

Gets the int value from this entry.

Returns:

value of this entry

Exceptions:

Inspirel.YAMI.BadTypeException

if this entry does not contain int value

int [] Inspirel.YAMI.Parameters.Entry.GetIntegerArray

(

)

Gets the int array from this entry.

Returns:

value of this entry

Exceptions:

Inspirel.YAMI.BadTypeException

if this entry does not contain int array

long Inspirel.YAMI.Parameters.Entry.GetLong

(

)

Gets the long value from this entry.

Returns:

value of this entry

Exceptions:

Inspirel.YAMI.BadTypeException

if this entry does not contain long value

long [] Inspirel.YAMI.Parameters.Entry.GetLongArray

(

)

Gets the long array from this entry.

Returns:

value of this entry

Exceptions:

Inspirel.YAMI.BadTypeException

if this entry does not contain long array

Parameters Inspirel.YAMI.Parameters.Entry.GetNestedParameters

(

)

Gets the nested Parameters object from this entry.

Returns:

value of this entry

Exceptions:

Inspirel.YAMI.BadTypeException

if this entry does not contain nested Parameters object

string Inspirel.YAMI.Parameters.Entry.GetString

(

)

Gets the string value from this entry.

Returns:

value of this entry

Exceptions:

Inspirel.YAMI.BadTypeException

if this entry does not contain string value

string [] Inspirel.YAMI.Parameters.Entry.GetStringArray

(

)

Gets the string array from this entry.

Returns:

value of this entry

Exceptions:

Inspirel.YAMI.BadTypeException

if this entry does not contain string array

---

Property Documentation

string Inspirel.YAMI.Parameters.Entry.Name [get]

Gets the name of this entry.

Returns:

name of this entry

EntryType Inspirel.YAMI.Parameters.Entry.Type [get]

Gets the type of this entry.

Returns:

type of this entry

---

The documentation for this class was generated from the following file:

• src/Parameters.cs