Report status of all API calls. More...

#include <api_status.h>

Public Member Functions
int	get_error_code () const
	(API Error Codes) Get the error code All API calls will return a status code. If the optional api_status object is passed in, the code is set in the object also. More...

const char *	get_error_msg () const
	(API Error Codes) Get the error msg string All API calls will return a status code. If the optional api_status object is passed in, the detailed error description is passed back using get_error_msg() More...

Static Public Member Functions
static void	try_update (api_status status, int new_code, const char new_msg)
	Helper method for returning error object Checks to see if api_status is not null before setting the error code and error message. More...

static void	try_clear (api_status *status)
	Helper method to clear the error object Checks to see if api_status is not null before clearing current values. More...

Detailed Description

Report status of all API calls.

Examples: rl_sim.cc.

Member Function Documentation

◆ get_error_code()

int reinforcement_learning::api_status::get_error_code ( ) const

(API Error Codes) Get the error code All API calls will return a status code. If the optional api_status object is passed in, the code is set in the object also.

Returns: int Error code

◆ get_error_msg()

const char* reinforcement_learning::api_status::get_error_msg ( ) const

(API Error Codes) Get the error msg string All API calls will return a status code. If the optional api_status object is passed in, the detailed error description is passed back using get_error_msg()

Returns: const char* Error description

Examples: rl_sim.cc.

◆ try_clear()

static void reinforcement_learning::api_status::try_clear ( api_status * status )

static

Helper method to clear the error object Checks to see if api_status is not null before clearing current values.

Parameters

status Error object. Could be null.

◆ try_update()

static void reinforcement_learning::api_status::try_update	(	api_status *	status,
		int	new_code,
		const char *	new_msg
	)

static

Helper method for returning error object Checks to see if api_status is not null before setting the error code and error message.