Optimization : Optimization Namespace

Settings Class

Optimization settings class.

public class Settings : IEnumerable<KeyValuePair<string, object>>

Remarks

Convenient class for storing settings that can be easily deserialized. All public fields in this class are considered settings and when an instance is constructed each of these fields are retrieved and stored in a dictionary to be accessed by their names. As such, you can easily set a setting by its name rather than directly, which allows to easily set setting values when reading them from a configuration file for example.

By default, the field name will be used as the setting name under which to provide dynamic access to settings. You can specify an alternative name by using the Optimization.SettingAttribute attribute on a field.

Requirements

Namespace: Optimization
Assembly: Optimization (in Optimization.dll)

Members

See Also: Inherited members from object.

Public Constructors

Create new settings.

Public Properties

default property
Item (string) object . Access a setting by its name.

Public Methods

All () : Dictionary<string, object>
Dictionary of all settings.
Clear ()
Clear all settings.
Description (string) : string
Get description for setting.
GetEnumerator () : IEnumerator<KeyValuePair<string, object>>
Settings enumerator.

Explicitly Implemented Interface Members

IEnumerable.GetEnumerator Setting enumerator.

Member Details

Settings Constructor

Create new settings.

public Settings ()

Remarks

Create new settings.

Requirements

Namespace: Optimization
Assembly: Optimization (in Optimization.dll)

All Method

Dictionary of all settings.

Returns

Dictionary of all settings.

Remarks

Get a dictionary of all the settings.

Requirements

Namespace: Optimization
Assembly: Optimization (in Optimization.dll)

Clear Method

Clear all settings.

public void Clear ()

Remarks

Clear all settings.

Requirements

Namespace: Optimization
Assembly: Optimization (in Optimization.dll)

Description Method

Get description for setting.

public string Description (string name)

Parameters

name
Setting name.

Returns

Setting description.

Remarks

Get the description of a certain setting.

Requirements

Namespace: Optimization
Assembly: Optimization (in Optimization.dll)

GetEnumerator Method

Settings enumerator.

Returns

Settings enumerator.

Remarks

Settings enumerator.

Requirements

Namespace: Optimization
Assembly: Optimization (in Optimization.dll)

Item Property

Access a setting by its name.

This is the default property for this class.

public object this [string name] { set; get; }

Parameters

name
Setting name.

Value

Setting value.

Remarks

Access a setting by its name.

Requirements

Namespace: Optimization
Assembly: Optimization (in Optimization.dll)

System.Collections.IEnumerable.GetEnumerator Method

Setting enumerator.

IEnumerator System.Collections.IEnumerable.GetEnumerator ()

Returns

Setting enumerator.

Remarks

Setting enumerator.

Requirements

Namespace: Optimization
Assembly: Optimization (in Optimization.dll)