gxSystem Class Reference

List of all members.

---

Detailed Description

Class for the GX-system specific operations.

Static Public Member Functions
static bool	SetErrorv (int flags, int code, const wchar_t *format, va_list args)
	Updates the thread-local error in the GX system (Unicode version).
static bool	SetErrorv (int code, const wchar_t *format, va_list args)
	Overwrites the thread-local error in the GX system (Unicode version).
static bool	AppendErrorv (int code, const wchar_t *format, va_list args)
	Appends the thread-local error in the GX system (Unicode version).
static bool	PrependErrorv (int code, const wchar_t *format, va_list args)
	Prepends the thread-local error in the GX system (Unicode version).
static bool	SetError (int flags, int code, const wchar_t *format,...)
	Updates the thread-local error in the GX system (Unicode version).
static bool	SetErrorv (int flags, int code, const char *format, va_list args)
	Updates the thread-local error in the GX system (ASCII version).
static bool	SetErrorv (int code, const char *format, va_list args)
	Overwrites the thread-local error in the GX system (ASCII version).
static bool	AppendErrorv (int code, const char *format, va_list args)
	Appends the thread-local error in the GX system (ASCII version).
static bool	PrependErrorv (int code, const char *format, va_list args)
	Prepends the thread-local error in the GX system (ASCII version).
static bool	SetError (int flags, int code, const char *format,...)
	Updates the thread-local error in the GX system (ASCII version).
static bool	SetError (int code, const wchar_t *format,...)
	Overwrites the thread-local error in the GX system (Unicode version).
static bool	SetError (int code, const char *format,...)
	Overwrites the thread-local error in the GX system (ASCII version).
static bool	AppendError (int code, const wchar_t *format,...)
	Appends the thread-local error in the GX system (Unicode version).
static bool	AppendError (int code, const char *format,...)
	Appends the thread-local error in the GX system (ASCII version).
static bool	PrependError (int code, const wchar_t *format,...)
	Prepends the thread-local error in the GX system (Unicode version).
static bool	PrependError (int code, const char *format,...)
	Prepends the thread-local error in the GX system (ASCII version).
static bool	ClearError (void)
	Clears the thread-local error buffer in the GX system.
static bool	SetError (int code)
	Overwrites the thread-local error in the GX system.
static bool	AppendError (int code)
	Appends the thread-local error in the GX system.
static bool	PrependError (int code)
	Prepends the thread-local error in the GX system.
static bool	SetError (int flags, int code, gxInStr str)
	Updates the thread-local error in the GX system (Unicode version).
static bool	SetError (int code, gxInStr str)
	Overwrites the thread-local error in the GX system (Unicode version).
static bool	AppendError (int code, gxInStr str)
	Appends the thread-local error in the GX system (Unicode version).
static bool	PrependError (int code, gxInStr str)
	Prepends the thread-local error in the GX system (Unicode version).
static bool	SetError (int flags, int code, gxInAStr str)
	Updates the thread-local error in the GX system (ASCII version).
static bool	SetError (int code, gxInAStr str)
	Overwrites the thread-local error in the GX system (ASCII version).
static bool	AppendError (int code, gxInAStr str)
	Appends the thread-local error in the GX system (ASCII version).
static bool	PrependError (int code, gxInAStr str)
	Prepends the thread-local error in the GX system (ASCII version).
static int	GetErrorCode (void)
	Getting the error code.
static int	GetError (int *code, wchar_t *string, int maxlen)
	Getting the error code and string in unicode format.
static int	GetError (int *code, char *string, int maxlen)
	Getting the error code and string in ASCII format.
static gxOutStr	GetErrorString (void)
	Getting the error string in unicode format.
static gxOutAStr	GetErrorStringA (void)
	Getting the error string in ASCII format.
static std::vector< gxDeviceInfo >	ListDevices (unsigned int flags, gxDeviceInfo &filter) throw (gxError)
	This function returns a filtered list of the available GX devices (Unicode version).
static std::vector< gxDeviceInfoA >	ListDevicesA (unsigned int flags, gxDeviceInfoA &filter) throw (gxError)
	This function returns a filtered list of the available GX devices (ASCII version).
static bool	PushError (void) throw (gxError)
	This function pushes the error code and string to the error stack.
static bool	PopError (void) throw (gxError)
	This function pops the error code and string from the error stack.
static int	GetSystemInfo (GX_SYSINFO_FLAGS flag) throw (gxError)
	Returns information about the GX system.

---

Member Function Documentation

static bool SetErrorv	(	int	flags,
		int	code,
		const wchar_t *	format,
		va_list	args
	)			[inline, static]

Updates the thread-local error in the GX system (Unicode version).

Parameters:

	flags	Modifier flags (see GX_ERROR_FLAGS).
	code	The error code (see GX_ERROR_CODES).
	format	The format string (like for wprintf, use hs and ls instead of s).
	args	Arguments for the format string. (like for wprintf).

Returns:

On success: non-zero.

References gx_seterrorfv().

static bool SetErrorv	(	int	code,
		const wchar_t *	format,
		va_list	args
	)			[inline, static]

Overwrites the thread-local error in the GX system (Unicode version).

Parameters:

	code	The error code (see GX_ERROR_CODES).
	format	The format string (like for wprintf, use hs and ls instead of s).
	args	Arguments for the format string (like for wprintf).

Returns:

On success: non-zero.

References GX_ERR_FLAG_CLEAR.

static bool AppendErrorv	(	int	code,
		const wchar_t *	format,
		va_list	args
	)			[inline, static]

Appends the thread-local error in the GX system (Unicode version).

Parameters:

	code	The error code (see GX_ERROR_CODES).
	format	The format string (like for wprintf, use hs and ls instead of s).
	args	Arguments for the format string (like for wprintf).

Returns:

On success: non-zero.

References GX_ERR_FLAG_APPEND.

static bool PrependErrorv	(	int	code,
		const wchar_t *	format,
		va_list	args
	)			[inline, static]

Prepends the thread-local error in the GX system (Unicode version).

Parameters:

	code	The error code (see GX_ERROR_CODES).
	format	The format string (like for wprintf, use hs and ls instead of s).
	args	Arguments for the format string (like for wprintf).

Returns:

On success: non-zero.

References GX_ERR_FLAG_PREPEND.

static bool SetError	(	int	flags,
		int	code,
		const wchar_t *	format,
			...
	)			[inline, static]

Updates the thread-local error in the GX system (Unicode version).

Parameters:

	flags	Modifier flags (see GX_ERROR_FLAGS).
	code	The error code (see GX_ERROR_CODES).
	format	The format string (like for wprintf, use hs and ls instead of s).
	...	Arguments for the format string (like for wprintf).

Returns:

On success: non-zero.

Referenced by gxTrafo::ToVariant(), and gxImage::ToVariant().

static bool SetErrorv	(	int	flags,
		int	code,
		const char *	format,
		va_list	args
	)			[inline, static]

Updates the thread-local error in the GX system (ASCII version).

Parameters:

	flags	Modifier flags (see GX_ERROR_FLAGS).
	code	The error code (see GX_ERROR_CODES).
	format	The format string (like for wprintf, use hs and ls instead of s).
	args	Arguments for the format string (like for wprintf).

Returns:

On success: non-zero.

References gx_seterrorafv().

static bool SetErrorv	(	int	code,
		const char *	format,
		va_list	args
	)			[inline, static]

Overwrites the thread-local error in the GX system (ASCII version).

Parameters:

	code	The error code (see GX_ERROR_CODES).
	format	The format string (like for wprintf, use hs and ls instead of s).
	args	Arguments for the format string (like for wprintf).

Returns:

On success: non-zero.

References GX_ERR_FLAG_CLEAR.

static bool AppendErrorv	(	int	code,
		const char *	format,
		va_list	args
	)			[inline, static]

Appends the thread-local error in the GX system (ASCII version).

Parameters:

	code	The error code (see GX_ERROR_CODES).
	format	The format string (like for wprintf, use hs and ls instead of s).
	args	Arguments for the format string (like for wprintf).

Returns:

On success: non-zero.

References GX_ERR_FLAG_APPEND.

static bool PrependErrorv	(	int	code,
		const char *	format,
		va_list	args
	)			[inline, static]

Prepends the thread-local error in the GX system (ASCII version).

Parameters:

	code	The error code (see GX_ERROR_CODES).
	format	The format string (like for wprintf, use hs and ls instead of s).
	args	Arguments for the format string (like for wprintf).

Returns:

On success: non-zero.

References GX_ERR_FLAG_PREPEND.

static bool SetError	(	int	flags,
		int	code,
		const char *	format,
			...
	)			[inline, static]

Updates the thread-local error in the GX system (ASCII version).

Parameters:

	flags	Modifier flags (see GX_ERROR_FLAGS).
	code	The error code (see GX_ERROR_CODES).
	format	The format string (like for wprintf, use hs and ls instead of s).
	...	Arguments for the format string (like for wprintf).

Returns:

On success: non-zero.

static bool SetError	(	int	code,
		const wchar_t *	format,
			...
	)			[inline, static]

Overwrites the thread-local error in the GX system (Unicode version).

Parameters:

	code	The error code (see GX_ERROR_CODES).
	format	The format string (like for wprintf, use hs and ls instead of s).
	...	Arguments for the format string (like for wprintf).

Returns:

On success: non-zero.

static bool SetError	(	int	code,
		const char *	format,
			...
	)			[inline, static]

Overwrites the thread-local error in the GX system (ASCII version).

Parameters:

	code	The error code (see GX_ERROR_CODES).
	format	The format string (like for wprintf, use hs and ls instead of s).
	...	Arguments for the format string (like for wprintf).

Returns:

On success: non-zero.

static bool AppendError	(	int	code,
		const wchar_t *	format,
			...
	)			[inline, static]

Appends the thread-local error in the GX system (Unicode version).

Parameters:

	code	The error code (see GX_ERROR_CODES).
	format	The format string (like for wprintf, use hs and ls instead of s).
	...	Arguments for the format string (like for wprintf).

Returns:

On success: non-zero.

static bool AppendError	(	int	code,
		const char *	format,
			...
	)			[inline, static]

Appends the thread-local error in the GX system (ASCII version).

Parameters:

	code	The error code (see GX_ERROR_CODES).
	format	The format string (like for wprintf, use hs and ls instead of s).
	...	Arguments for the format string (like for wprintf).

Returns:

On success: non-zero.

static bool PrependError	(	int	code,
		const wchar_t *	format,
			...
	)			[inline, static]

Prepends the thread-local error in the GX system (Unicode version).

Parameters:

	code	The error code (see GX_ERROR_CODES).
	format	The format string (like for wprintf, use hs and ls instead of s).
	...	Arguments for the format string (like for wprintf).

Returns:

On success: non-zero.

static bool PrependError	(	int	code,
		const char *	format,
			...
	)			[inline, static]

Prepends the thread-local error in the GX system (ASCII version).

Parameters:

	code	The error code (see GX_ERROR_CODES).
	format	The format string (like for wprintf, use hs and ls instead of s).
	...	Arguments for the format string (like for wprintf).

Returns:

On success: non-zero.

static bool ClearError

(

void

)

[inline, static]

Clears the thread-local error buffer in the GX system.

Returns:

On success: non-zero.

References gx_clearerror().

static bool SetError

(

int

code

)

[inline, static]

Overwrites the thread-local error in the GX system.

Parameters:

code

The error code (see GX_ERROR_CODES).

Returns:

On success: non-zero.

References GX_ERR_FLAG_CLEAR, and gx_seterrorf().

static bool AppendError

(

int

code

)

[inline, static]

Appends the thread-local error in the GX system.

Parameters:

code

The error code (see GX_ERROR_CODES).

Returns:

On success: non-zero.

References GX_ERR_FLAG_APPEND, and gx_seterrorf().

static bool PrependError

(

int

code

)

[inline, static]

Prepends the thread-local error in the GX system.

Parameters:

code

The error code (see GX_ERROR_CODES).

Returns:

On success: non-zero.

References GX_ERR_FLAG_PREPEND, and gx_seterrorf().

static bool SetError	(	int	flags,
		int	code,
		gxInStr	str
	)			[inline, static]

Updates the thread-local error in the GX system (Unicode version).

Parameters:

	flags	Modifier flags (see GX_ERROR_FLAGS).
	code	The error code (see GX_ERROR_CODES).
	str	The extension string. (The result will be the system's string plus your extension string.)

Returns:

On success: non-zero.

References gx_seterrorf().

static bool SetError	(	int	code,
		gxInStr	str
	)			[inline, static]

Overwrites the thread-local error in the GX system (Unicode version).

Parameters:

	code	The error code (see GX_ERROR_CODES).
	str	The extension string. (The result will be the system's string plus your extension string.)

Returns:

On success: non-zero.

References GX_ERR_FLAG_CLEAR, and gx_seterrorf().

static bool AppendError	(	int	code,
		gxInStr	str
	)			[inline, static]

Appends the thread-local error in the GX system (Unicode version).

Parameters:

	code	The error code (see GX_ERROR_CODES).
	str	The extension string. (The result will be the system's string plus your extension string.)

Returns:

On success: non-zero.

References GX_ERR_FLAG_APPEND, and gx_seterrorf().

static bool PrependError	(	int	code,
		gxInStr	str
	)			[inline, static]

Prepends the thread-local error in the GX system (Unicode version).

Parameters:

	code	The error code (see GX_ERROR_CODES).
	str	The extension string. (The result will be the system's string plus your extension string.)

Returns:

On success: non-zero.

References GX_ERR_FLAG_PREPEND, and gx_seterrorf().

static bool SetError	(	int	flags,
		int	code,
		gxInAStr	str
	)			[inline, static]

Updates the thread-local error in the GX system (ASCII version).

Parameters:

	flags	Modifier flags (see GX_ERROR_FLAGS).
	code	The error code (see GX_ERROR_CODES).
	str	The extension string. (The result will be the system's string plus your extension string.)

Returns:

On success: non-zero.

References gx_seterrorf().

static bool SetError	(	int	code,
		gxInAStr	str
	)			[inline, static]

Overwrites the thread-local error in the GX system (ASCII version).

Parameters:

	code	The error code (see GX_ERROR_CODES).
	str	The extension string. (The result will be the system's string plus your extension string.)

Returns:

On success: non-zero.

References GX_ERR_FLAG_CLEAR, and gx_seterrorf().

static bool AppendError	(	int	code,
		gxInAStr	str
	)			[inline, static]

Appends the thread-local error in the GX system (ASCII version).

Parameters:

	code	The error code (see GX_ERROR_CODES).
	str	The extension string. (The result will be the system's string plus your extension string.)

Returns:

On success: non-zero.

References GX_ERR_FLAG_APPEND, and gx_seterrorf().

static bool PrependError	(	int	code,
		gxInAStr	str
	)			[inline, static]

Prepends the thread-local error in the GX system (ASCII version).

Parameters:

	code	The error code (see GX_ERROR_CODES).
	str	The extension string. (The result will be the system's string plus your extension string.)

Returns:

On success: non-zero.

References GX_ERR_FLAG_PREPEND, and gx_seterrorf().

static int GetErrorCode

(

void

)

[inline, static]

Getting the error code.

Returns:

The error code.

References gx_geterrorcode().

static int GetError	(	int *	code,
		wchar_t *	string,
		int	maxlen
	)			[inline, static]

Getting the error code and string in unicode format.

Parameters:

	code	Pointer where the function writes the error code.
	string	Pointer to a memory area in which the function writes the string.
	maxlen	Length of the memory area in characters.

Returns:

The error code (Yes, it is the code not status).

References gx_geterror().

static int GetError	(	int *	code,
		char *	string,
		int	maxlen
	)			[inline, static]

Getting the error code and string in ASCII format.

Parameters:

	code	Pointer where the function writes the error code.
	string	Pointer to a memory area in which the function writes the string.
	maxlen	Length of the memory area in characters.

Returns:

The error code (Yes, it is the code not status).

References gx_geterrora().

static gxOutStr GetErrorString

(

void

)

[inline, static]

Getting the error string in unicode format.

Returns:

The error string.

References gx_geterror().

static gxOutAStr GetErrorStringA

(

void

)

[inline, static]

Getting the error string in ASCII format.

Returns:

The error string.

References gx_geterrora().

static std::vector<gxDeviceInfo> ListDevices	(	unsigned int	flags,
		gxDeviceInfo &	filter
	)			throw (gxError) [inline, static]

This function returns a filtered list of the available GX devices (Unicode version).

Parameters:

	flags	Flags for filter class.
	filter	The filter class.

Returns:

The array of the devices found. If an error occurred the function throws an exception.

References GX_ENOMEM, and gx_listdevices().

static std::vector<gxDeviceInfoA> ListDevicesA	(	unsigned int	flags,
		gxDeviceInfoA &	filter
	)			throw (gxError) [inline, static]

This function returns a filtered list of the available GX devices (ASCII version).

Parameters:

	flags	Flags for filter class.
	filter	The filter class.

Returns:

The array of the devices found. If an error occurred the function throws an exception.

References GX_ENOMEM, and gx_listdevicesa().

static bool PushError

(

void

)

throw (gxError) [inline, static]

This function pushes the error code and string to the error stack.

Returns:

On success: non-zero.

References gx_pusherror().

static bool PopError

(

void

)

throw (gxError) [inline, static]

This function pops the error code and string from the error stack.

Returns:

On success: non-zero.

References gx_poperror().

static int GetSystemInfo

(

GX_SYSINFO_FLAGS

flag

)

throw (gxError) [inline, static]

Returns information about the GX system.

Parameters:

flag

Flag to select the type of the information.

Returns:

The result depends on the flag parameter. In case of error an exception is thrown.

References GX_SYSTEM_INFO::cm_accr, GX_SYSTEM_INFO::cm_face, GX_SYSTEM_INFO::cm_ff, GX_SYSTEM_INFO::cm_park, GX_SYSTEM_INFO::cm_pl, gx_getsysteminfo(), GX_SYSINFO_FLAG_ACCR, GX_SYSINFO_FLAG_FACE, GX_SYSINFO_FLAG_FREEFLOW, GX_SYSINFO_FLAG_PARKING, GX_SYSINFO_FLAG_PARKINGLANE, GX_SYSINFO_FLAG_PR, GX_SYSTEM_INFO::pr, and GX_SYSTEM_INFO::size.