The GymCollection contains the available Gyms. More...

Inheritance diagram for MyCaffe.gym.GymCollection:

Public Member Functions
	GymCollection ()
	The constructor. More...

List< Exception >	Load ()
	Loads the default and dynamic gyms. More...

IXMyCaffeGym	Find (string strName)
	Search for a given Gym by its name. More...

IEnumerator< IXMyCaffeGym >	GetEnumerator ()
	Returns the collections enumerator. More...

Detailed Description

The GymCollection contains the available Gyms.

Definition at line 15 of file GymCollection.cs.

Constructor & Destructor Documentation

◆ GymCollection()

MyCaffe.gym.GymCollection.GymCollection ( )

The constructor.

Definition at line 22 of file GymCollection.cs.

Member Function Documentation

◆ Find()

IXMyCaffeGym MyCaffe.gym.GymCollection.Find ( string strName )

Search for a given Gym by its name.

Parameters

strName Specifies the name of the Gym to look for.

Returns: If found the Gym IXMyCaffeGym interface is returned, otherwise null is returned.

Definition at line 130 of file GymCollection.cs.

◆ GetEnumerator()

IEnumerator< IXMyCaffeGym > MyCaffe.gym.GymCollection.GetEnumerator ( )

Returns the collections enumerator.

Returns: The enumerator is returned.

Definition at line 149 of file GymCollection.cs.

◆ Load()

List< Exception > MyCaffe.gym.GymCollection.Load ( )

Loads the default and dynamic gyms.

Each dynamic Gym must implement a DLL with the IXMyCaffeGym interface implemented. When loading dynamic Gym's, this class looks for these DLL's in the

./CustomGyms

directory relative to the location of the MyCaffe.gym assembly.

Returns: A list of errors occuring while loading Gyms is returned if any occur.

Definition at line 34 of file GymCollection.cs.

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

C:/Data/Data/SS_Projects/Intelligence/GitHub/MyCaffe/MyCaffe.gym/GymCollection.cs