MyCaffe.gym.MyCaffeGymControl Class Reference

The MyCaffeGymControl displays the actual Gym visualizations. More...

Inheritance diagram for MyCaffe.gym.MyCaffeGymControl:

Public Member Functions
	MyCaffeGymControl ()
	The constructor. More...
void	DeleteRecordingData ()
	Delete any recording data that exists. More...
void	Render (string strName, Image bmp)
	Renders the Gym visualization. More...
void	Render (bool bShowUi, string strName, double[] rgData, Image bmp)
	Renders the Gym visualizations. More...

Protected Member Functions
override void	Dispose (bool disposing)
	Clean up any resources being used. More...

Properties
bool	EnableRecording [getset]
	Enable or disable recording. When recording is enabled, each image is saved to the recording folder. More...
List< Exception >	LoadErrors [get]
	Returns any load errors that may have occured while loading the gyms. More...
string	GymName [get]
	Returns the GymName. More...
bool	HasRecordingData [get]
	Returns whether or not the Gym has any recording data. More...

Detailed Description

The MyCaffeGymControl displays the actual Gym visualizations.

Definition at line 25 of file MyCaffeGymControl.cs.

Constructor & Destructor Documentation

MyCaffeGymControl()

MyCaffe.gym.MyCaffeGymControl.MyCaffeGymControl

(

)

The constructor.

Definition at line 38 of file MyCaffeGymControl.cs.

Member Function Documentation

DeleteRecordingData()

void MyCaffe.gym.MyCaffeGymControl.DeleteRecordingData

(

)

Delete any recording data that exists.

Definition at line 115 of file MyCaffeGymControl.cs.

Dispose()

override void MyCaffe.gym.MyCaffeGymControl.Dispose ( bool  disposing )

protected

Clean up any resources being used.

Parameters

disposing

true if managed resources should be disposed; otherwise, false.

Definition at line 14 of file MyCaffeGymControl.Designer.cs.

Render() [1/2]

void MyCaffe.gym.MyCaffeGymControl.Render	(	bool	bShowUi,
		string	strName,
		double[]	rgData,
		Image	bmp
	)

Renders the Gym visualizations.

Parameters

bShowUi	Specifies whether or not to render for the user interface.
strName	Specifies the Gym name.
rgData	Specifies the Gym data.
bmp	Specifies the Gym image to use.

Definition at line 153 of file MyCaffeGymControl.cs.

Render() [2/2]

void MyCaffe.gym.MyCaffeGymControl.Render	(	string	strName,
		Image	bmp
	)

Renders the Gym visualization.

Parameters

strName	Specifies the Gym Name.
bmp	Specifies the Gym image to visualize.

Definition at line 135 of file MyCaffeGymControl.cs.

Property Documentation

EnableRecording

bool MyCaffe.gym.MyCaffeGymControl.EnableRecording

getset

Enable or disable recording. When recording is enabled, each image is saved to the recording folder.

The recording folder is located in the My Documents folder under MyDocuments\MyCaffe\gym\recordings.

Definition at line 51 of file MyCaffeGymControl.cs.

GymName

string MyCaffe.gym.MyCaffeGymControl.GymName

get

Returns the GymName.

Definition at line 68 of file MyCaffeGymControl.cs.

HasRecordingData

bool MyCaffe.gym.MyCaffeGymControl.HasRecordingData

get

Returns whether or not the Gym has any recording data.

Definition at line 98 of file MyCaffeGymControl.cs.

LoadErrors

List<Exception> MyCaffe.gym.MyCaffeGymControl.LoadErrors

get

Returns any load errors that may have occured while loading the gyms.

Definition at line 60 of file MyCaffeGymControl.cs.

---

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

• C:/Data/Data/SS_Projects/Intelligence/GitHub/MyCaffe/MyCaffe.gym/MyCaffeGymControl.cs
• C:/Data/Data/SS_Projects/Intelligence/GitHub/MyCaffe/MyCaffe.gym/MyCaffeGymControl.Designer.cs