MyCaffe.gym.MyCaffeGymUiService Class Reference

The MyCaffeGymUiService provides the service used to show the Gym visualizations. More...

Inheritance diagram for MyCaffe.gym.MyCaffeGymUiService:

Public Member Functions
	MyCaffeGymUiService ()
	The constructor. More...
void	CloseUi (int nId)
	Close the user interface of a Gym. More...
int	OpenUi (string strName, int nId, bool bStartRecording=false)
	Open the Gym user interface. More...
void	Render (int nId, Observation obs)
	Render an observation on the Gym user-interface. More...
bool	IsOpen (int nId)
	Returns true when the visualization is open, false otherwise. More...

Detailed Description

The MyCaffeGymUiService provides the service used to show the Gym visualizations.

Definition at line 14 of file MyCaffeGymUiService.cs.

Constructor & Destructor Documentation

MyCaffeGymUiService()

MyCaffe.gym.MyCaffeGymUiService.MyCaffeGymUiService

(

)

The constructor.

Definition at line 23 of file MyCaffeGymUiService.cs.

Member Function Documentation

CloseUi()

void MyCaffe.gym.MyCaffeGymUiService.CloseUi

(

int

nId

)

Close the user interface of a Gym.

Parameters

nId	Specifies the Gym id (used when multiple Gym's of the same name are used).

Implements MyCaffe.gym.IXMyCaffeGymUiService.

Definition at line 41 of file MyCaffeGymUiService.cs.

IsOpen()

bool MyCaffe.gym.MyCaffeGymUiService.IsOpen

(

int

nId

)

Returns true when the visualization is open, false otherwise.

Parameters

nId	Specifies the Gym ID.

Returns

Returns true when the visualization is open, false otherwise.

Implements MyCaffe.gym.IXMyCaffeGymUiService.

Definition at line 110 of file MyCaffeGymUiService.cs.

OpenUi()

int MyCaffe.gym.MyCaffeGymUiService.OpenUi	(	string	strName,
		int	nId,
		bool	bStartRecording = false
	)

Open the Gym user interface.

Parameters

strName	Specifies the Gym name.
nId	Specifies the ID of the Gym.
bStartRecording	Optionally, specifies to open with recording on.

Returns

The ID of the Gym opened is returned.

Implements MyCaffe.gym.IXMyCaffeGymUiService.

Definition at line 62 of file MyCaffeGymUiService.cs.

Render()

void MyCaffe.gym.MyCaffeGymUiService.Render	(	int	nId,
		Observation	obs
	)

Render an observation on the Gym user-interface.

Parameters

nId	Specifies the Gym ID.
obs	Specifies the Observation to visualize.

Implements MyCaffe.gym.IXMyCaffeGymUiService.

Definition at line 89 of file MyCaffeGymUiService.cs.

---

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

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