Map

IMu.Map

IMu.Map

Since: 1.0

Description

Provides a simple map class with String keys and a set of convenience methods for getting values of certain types.

Methods

Method

Details

GetBool(name)

bool GetBool(string name)

Gets the value associated with the key name and returns it as a Boolean.

Parameters:

name (string)

The key whose associated value is to be returned.

Returns:

bool

The value, interpreted as a Boolean. Null values are considered false. Numeric values are considered false if they evaluate to 0, and true otherwise. Any other non-boolean value is converted to a String and then parsed as a Boolean.

GetBoolean(name)

bool GetBool(string name)

A convenience for VB users. Gets the value associated with the key name and returns it as a Boolean.

Parameters:

name (string)

The key whose associated value is to be returned.

Returns:

bool

The value, interpreted as a Boolean. Null values are considered false. Numeric values are considered false if they evaluate to 0, and true otherwise. Any other non-boolean value is converted to a String and then parsed as a Boolean.

GetDouble(name)

double GetDouble(string name)

Gets the value associated with the key name and returns it as a double precision floating point number.

Parameters:

name (string)

The key whose associated value is to be returned.

Returns:

double

The value, interpreted as a double. Null values evaluate to 0. Boolean values evaluate to 0 if false and 1 if true. Any other non-numeric value is converted to a String and then parsed as a double.

GetInt(name)

int GetInt(string name)

Gets the value associated with the key name and returns it as an int.

Parameters:

name (string)

The key whose associated value is to be returned.

Returns:

int

The value, interpreted as an int. Null values evaluate to 0. Boolean values evaluate to 0 if false and 1 if true. Any other non-numeric value is converted to a String and then parsed as an int.

GetInteger(name)

int GetInteger(string name)

A convenience for VB users. Gets the value associated with the key name and returns it as an int.

Parameters:

name (string)

The key whose associated value is to be returned.

Returns:

int

The value, interpreted as an int. Null values evaluate to 0. Boolean values evaluate to 0 if false and 1 if true. Any other non-numeric value is converted to a String and then parsed as an integer.

GetLong(name)

long GetLong(string name)

Gets the value associated with the key name and returns it as a long integer.

Parameters:

name (string)

The key whose associated value is to be returned.

Returns:

long

The value, interpreted as a long. Null values evaluate to 0. Boolean values evaluate to 0 if false and 1 if true. Any other non-numeric value is converted to a String and then parsed as a long.

GetMap(name)

Map GetMap(string name)

Gets the value associated with the key name and returns it as an IMu Map object.

Parameters:

name (string)

The key whose associated value is to be returned.

Returns:

Map

The value, cast to a Map.

GetMaps(name)

Map[] GetMaps(string name)

Gets the value associated with the key name and returns it as an array of IMu Map objects.

Parameters:

name (string)

The key whose associated value is to be returned.

Returns:

Map[]

The value, cast to an array of Map objects.

GetString(name)

string GetString(string name)

Gets the value associated with the key name and returns it as a String.

Parameters:

name (string)

The key whose associated value is to be returned.

Returns:

string

The value, interpreted as a String. Null values remain null. Any other non-string value is converted to a String using the object's ToString( ) method.

GetStrings(name)

string[] GetStrings(string name)

Gets the value associated with the key name and returns it as an array of Strings.

Parameters:

name (string)

The key whose associated value is to be returned.

Returns:

string[]

The value, converted to an array of strings.