MyCaffe.gym.MyCaffeGymUiProxy Class Reference

The MyCaffeGymUiProxy is used to interact with the MyCaffeGymUiService. More...

Inheritance diagram for MyCaffe.gym.MyCaffeGymUiProxy:

Public Member Functions
	MyCaffeGymUiProxy (InstanceContext ctx, NetNamedPipeBinding binding=null)
	The constructor. More...
int	OpenUi (string strName, int nId, bool bStartRecording=false)
	Open the Gym user interface. More...
void	CloseUi (int nId)
	Closes the Gym user interface. More...
void	Render (int nId, Observation obs)
	Render the observation of the Gym. More...
bool	IsOpen (int nId)
	Returns whether or not the Gym user interface is visible or not. More...

Detailed Description

The MyCaffeGymUiProxy is used to interact with the MyCaffeGymUiService.

Definition at line 14 of file MyCaffeGymUiProxy.cs.

Constructor & Destructor Documentation

MyCaffeGymUiProxy()

MyCaffe.gym.MyCaffeGymUiProxy.MyCaffeGymUiProxy	(	InstanceContext	ctx,
		NetNamedPipeBinding	binding = null
	)

The constructor.

Parameters

ctx	Specifies the context.
binding	Optionally, specifies the binding. Specifying a binding can be useful when you need to set larger buffer sizes.

Definition at line 24 of file MyCaffeGymUiProxy.cs.

Member Function Documentation

CloseUi()

void MyCaffe.gym.MyCaffeGymUiProxy.CloseUi

(

int

nId

)

Closes the Gym user interface.

Parameters

nId	Specifies the ID of the Gym.

Definition at line 47 of file MyCaffeGymUiProxy.cs.

IsOpen()

bool MyCaffe.gym.MyCaffeGymUiProxy.IsOpen

(

int

nId

)

Returns whether or not the Gym user interface is visible or not.

Parameters

nId	Specifies the ID of the Gym.

Returns

Returns true if the Gym is visible, false otherwise.

Definition at line 83 of file MyCaffeGymUiProxy.cs.

OpenUi()

int MyCaffe.gym.MyCaffeGymUiProxy.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.

Definition at line 37 of file MyCaffeGymUiProxy.cs.

Render()

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

Render the observation of the Gym.

Parameters

nId	Specifies the ID of the Gym.
obs	Specifies the Observation to render.

Definition at line 61 of file MyCaffeGymUiProxy.cs.

---

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

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