Crystal.IBehaviourCollection Interface Reference

Interface for BehaviourCollections. A behaviour collection contains behaviours and all sub-collections required for these behaviours. Namely, options, considerations and actions. More...

Inheritance diagram for Crystal.IBehaviourCollection:

Public Member Functions
bool	Add (IBehaviour behaviour)
	Adds the given behaviour to this collection. More...
bool	Contains (string behaviourId)
	Determines whether a behaviour with the specified name identifier exists within this collection. More...
void	Clear ()
	Removes all behaviours from this collection. More...
void	ClearAll ()
	Removes all behaviours from this collection. Additionally all options are removed from the T:Crystal.IOptionCollection used in constructing this collection as well as all considerations and actions are removed from their respective collections. More...
IBehaviour	Create (string behaviourId)
	Creates a behaviour with the specified identifier if such a behaviour exists; otherwise returns null. More...

Properties
IOptionCollection	Options [get]
	The T:Crystal.IOptionCollection used to construct this collection. More...

Detailed Description

Interface for BehaviourCollections. A behaviour collection contains behaviours and all sub-collections required for these behaviours. Namely, options, considerations and actions.

Member Function Documentation

bool Crystal.IBehaviourCollection.Add

(

IBehaviour

behaviour

)

Adds the given behaviour to this collection.

Parameters

behaviour

The behaviour.

Returns

true if the behaviour was added to the collection; otherwise, false.

Implemented in Crystal.BehaviourCollection.

void Crystal.IBehaviourCollection.Clear

(

)

Removes all behaviours from this collection.

Implemented in Crystal.BehaviourCollection.

void Crystal.IBehaviourCollection.ClearAll

(

)

Removes all behaviours from this collection. Additionally all options are removed from the T:Crystal.IOptionCollection used in constructing this collection as well as all considerations and actions are removed from their respective collections.

Implemented in Crystal.BehaviourCollection.

bool Crystal.IBehaviourCollection.Contains

(

string

behaviourId

)

Determines whether a behaviour with the specified name identifier exists within this collection.

Parameters

behaviourId

The name identifier.

Returns

true if a behaviour with the specified identifier exists within the collection; otherwise, false.

Implemented in Crystal.BehaviourCollection.

IBehaviour Crystal.IBehaviourCollection.Create

(

string

behaviourId

)

Creates a behaviour with the specified identifier if such a behaviour exists; otherwise returns null.

Parameters

behaviourId

The behaviour identifier.

Implemented in Crystal.BehaviourCollection.

Property Documentation

IOptionCollection Crystal.IBehaviourCollection.Options

get

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

---

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

• Source/Behaviours/Interfaces/IBehaviourCollection.cs