IConfigValueBag

Description

interface Tinman.Core.Config.IConfigValueBag

Derived from

IConfigTypeBag

Extended by

ConfigValueBag sealed
IConfigScope

An IConfigValueBag represents a scope of named ConfigValues.

The set of existing config values is exposed via the base IConfigTypeBag interface. Value bags are used during runtime for evaluating expressions resp. functions and for storing values.

Public / Methods

GetMemberNull


public method GetMemberNull → (1)

name in : string

[not-null]
The name.

returns → ConfigMember

The ConfigMember or null.

Returns the ConfigMember which corresponds to the given named config object.

GetValueNull


public method GetValueNull → (2)

name in : string

[not-null]
The name.

arguments opt : ConfigValue [ ] = null

Optional arguments for function call. If null, a field value is accessed. When not null, a function call is performed.

returns → ConfigValue

The object or null if there is no object named name in.

Returns the config value that has the given name.

ConfigException

If an unexpected error has occurred while obtaining the config value, for example while evaluating default argument expressions for a function call or while retrieving a virtual field of a class value.

Extensions

GetArguments


public static method GetArguments → (1)

parameters in : IVectorConst<ConfigMember>

[not-null]
The list of named parameters.

returns → IVectorConst<ConfigValue>

The list of argument values, fetched from this value bag.

Returns an argument value list for the given parameter list.

ConfigException

If one or more names in parameters in are invalid or if an unexpected error has occurred while obtaining the config value, for example while evaluating argument expressions for a function call or while retrieving a virtual field of a class value.

GetValue

2 overloads


public static method GetValue1 → (3)

name in : string

[not-null]
The name.

arguments in : ConfigExpression [ ]

Optional arguments.

argumentScope opt : IConfigValueBag = null

Optional IConfigValueBag object to use for evaluating the given arguments in. If null, this bag is used.

returns → ConfigValue

The object.

Returns the config type that has the given name.

ConfigException

If no object named name in exists or if an unexpected error has occurred while obtaining the config value, for example while evaluating argument expressions for a function call or while retrieving a virtual field of a class value.


public static method GetValue2 → (2)

name in : string

[not-null]
The name.

arguments opt : ConfigValue [ ] = null

Optional arguments for function call. If null a field value is accessed. When not null a function call is intended.

returns → ConfigValue

The object.

Returns the config type that has the given name.

ConfigException

If no object named name in exists or if an unexpected error has occurred while obtaining the config value, for example while evaluating argument expressions for a function call or while retrieving a virtual field of a class value.

GetValueNull


public static method GetValueNull → (3)

name in : string

[not-null]
The name.

arguments in : ConfigExpression [ ]

Optional arguments for function call. If null a field value is accessed. When not null a function call is intended.

argumentScope opt : IConfigValueBag = null

Optional IConfigValueBag object to use for evaluating the given arguments in. If null, this bag is used.

returns → ConfigValue

The object or null if there is no object named name in.

Returns the config value that has the given name.

ConfigException

If an unexpected error has occurred while obtaining the config value, for example while evaluating argument expressions for a function call or while retrieving a virtual field of a class value.