MyCaffe.gym.IXMyCaffeGymUiService Interface Reference

The IXMYCaffeGymUiService interface provides access to the MyCaffeGymUiService used to display the visualizations of each Gym as they run. More...

Inheritance diagram for MyCaffe.gym.IXMyCaffeGymUiService:

Public Member Functions
int	OpenUi (string strName, int nId, bool bStartRecording=false)
	Open the user interface of a Gym. More...
void	CloseUi (int nId)
	Close the user interface of a Gym. 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 IXMYCaffeGymUiService interface provides access to the MyCaffeGymUiService used to display the visualizations of each Gym as they run.

Definition at line 19 of file IMyCaffeGymUiService.cs.

Member Function Documentation

CloseUi()

void MyCaffe.gym.IXMyCaffeGymUiService.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).

Implemented in MyCaffe.gym.MyCaffeGymUiService.

IsOpen()

bool MyCaffe.gym.IXMyCaffeGymUiService.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.

Implemented in MyCaffe.gym.MyCaffeGymUiService.

OpenUi()

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

Open the user interface of a Gym.

Parameters

strName	Specifies the Gym name who's user-interface is to be displayed.
nId	Specifies the Gym id (used when multiple Gym's of the same name are used).
bStartRecording	Optionally, specifies to open with recording on.

Returns

The ID of the Gym opened is returned.

Implemented in MyCaffe.gym.MyCaffeGymUiService.

Render()

void MyCaffe.gym.IXMyCaffeGymUiService.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.

Implemented in MyCaffe.gym.MyCaffeGymUiService.

---

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

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