Crystal.OptionCollection Class Reference

A collection of AI T:Crystal.IOptions. More...

Inheritance diagram for Crystal.OptionCollection:

Classes
class	ActionCollectionNullException
class	ConsiderationCollectionNullException

Public Member Functions
bool	Add (IOption option)
	Adds the specified option to this collection. More...
bool	Contains (string optionId)
	Determines whether this collection contains the option associated with the specified identifier. More...
void	Clear ()
	Clears all T:Crystal.IOptions from this collection. More...
void	ClearAll ()
	Clears all T:Crystal.IOptions from this collection. Additionally all considerations are cleared from P:Crystal.IOptionCollection.Considerations and all actions are cleared from P:Crystal.IOptionCollection.Actions. More...
IOption	Create (string optionId)
	Creates an instance of the option that is associated with the given identifier. If such an option does not exist null is returned.f More...
	OptionCollection (IActionCollection actionCollection, IConsiderationCollection considerationCollection)
	Initializes a new instance of the OptionCollection class. More...

Properties
IActionCollection	Actions [get]
	The T:Crystal.IActionCollection used to construct this T:Crystal.IOptionCollection.. More...
IConsiderationCollection	Considerations [get]
	The T:Crystal.IConsiderationCollection used to construct this T:Crystal.IOptionCollection.. More...
Properties inherited from Crystal.IOptionCollection
IActionCollection	Actions [get]
	The T:Crystal.IActionCollection used to construct this T:Crystal.IOptionCollection.. More...
IConsiderationCollection	Considerations [get]
	The T:Crystal.IConsiderationCollection used to construct this T:Crystal.IOptionCollection.. More...

Detailed Description

A collection of AI T:Crystal.IOptions.

See also

T:Crystal.IOptionCollection

Constructor & Destructor Documentation

Crystal.OptionCollection.OptionCollection ( IActionCollection  actionCollection, IConsiderationCollection  considerationCollection  )

inline

Initializes a new instance of the OptionCollection class.

Parameters

actionCollection	The action collection.
considerationCollection	The consideration collection.

Exceptions

T:Crystal.OptionCollection.ActionCollectionNullException
T:Crystal.OptionCollection.ConsiderationCollectionNullException

Member Function Documentation

bool Crystal.OptionCollection.Add ( IOption  option )

inline

Adds the specified option to this collection.

Parameters

option

The option.

Returns

true if the T:Crystal.IOption was successfully added to this collection; otherwise, false.

Implements Crystal.IOptionCollection.

void Crystal.OptionCollection.Clear ( )

inline

Clears all T:Crystal.IOptions from this collection.

Implements Crystal.IOptionCollection.

void Crystal.OptionCollection.ClearAll ( )

inline

Clears all T:Crystal.IOptions from this collection. Additionally all considerations are cleared from P:Crystal.IOptionCollection.Considerations and all actions are cleared from P:Crystal.IOptionCollection.Actions.

Implements Crystal.IOptionCollection.

bool Crystal.OptionCollection.Contains ( string  optionId )

inline

Determines whether this collection contains the option associated with the specified identifier.

Parameters

optionId

The option identifier.

Returns

true if this collection contains an option with the specified identifier; otherwise, false.

Implements Crystal.IOptionCollection.

IOption Crystal.OptionCollection.Create ( string  optionId )

inline

Creates an instance of the option that is associated with the given identifier. If such an option does not exist null is returned.f

Parameters

optionId

The option identifier.

Returns

Implements Crystal.IOptionCollection.

Property Documentation

IActionCollection Crystal.OptionCollection.Actions

get

The T:Crystal.IActionCollection used to construct this T:Crystal.IOptionCollection..

IConsiderationCollection Crystal.OptionCollection.Considerations

get

The T:Crystal.IConsiderationCollection used to construct this T:Crystal.IOptionCollection..

---

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

• Source/Options/OptionCollection.cs