gxMotionDetector Class Reference

Inheritance diagram for gxMotionDetector:

List of all members.

---

Detailed Description

Class implementation of the motion detection module functions.

Public Member Functions
	gxMotionDetector () throw (gxError)
	Class initialization.
	gxMotionDetector (const wchar_t *propname, const wchar_t *modname=(const wchar_t *) 0) throw (gxError)
	Class initialization with place of properties and name of the module (Unicode version).
	gxMotionDetector (const char *propname, const char *modname=(const char *) 0) throw (gxError)
	Class initialization with place of properties and name of the module (ASCII version).
	gxMotionDetector (gxInStr propname, gxInStr modname) throw (gxError)
	Class initialization with place of properties and name of the module (Unicode version).
	gxMotionDetector (gxInStr propname) throw (gxError)
	Class initialization with place of properties (Unicode version).
	gxMotionDetector (gxInAStr propname, gxInAStr modname) throw (gxError)
	Class initialization with place of properties and name of the module (ASCII version).
	gxMotionDetector (gxInAStr propname) throw (gxError)
	Class initialization with place of properties (ASCII version).
bool	Iteration (gxIMAGE *image, int *max_difference) throw (gxError)
	Adding a new image to the stream.
int	Iteration (gxIMAGE *image) throw (gxError)
	Adding a new image to the stream.
int	Iteration (gxImageData &image) throw (gxError)
	Adding a new image to the stream.
int	Iteration (gxImage &image) throw (gxError)
	Adding a new image to the stream.
bool	Iteration (gxIMAGE *image, int *max_difference, int *min_difference, int *found_x1, int *found_y1, int *found_x2, int *found_y2) throw (gxError)
	Adding a new image to the stream.
bool	Iteration (gxIMAGE *image, gxMotionDetectorResult &result) throw (gxError)
	Adding a new image to the stream.
bool	Iteration (gxImageData &image, gxMotionDetectorResult &result) throw (gxError)
	Adding a new image to the stream.
bool	Iteration (gxImage &image, gxMotionDetectorResult &result) throw (gxError)
	Adding a new image to the stream.
void	Dispose (void)
	It disposes the class.
bool	Open (const wchar_t *modulename, const wchar_t *groupname=(const wchar_t *) 0) throw (gxError)
	Opens a GX system compatible module (Unicode version).
bool	Open (const char *modulename, const char *groupname=(const char *) 0) throw (gxError)
	Opens a GX system compatible module (ASCII version).
bool	Open (gxInStr modulename, gxInStr groupname) throw (gxError)
	Opens a GX system compatible module (Unicode version).
bool	Open (gxInStr modulename) throw (gxError)
	Opens a GX system compatible module with the default properties (Unicode version).
bool	Open (gxInAStr modulename, gxInAStr groupname) throw (gxError)
	Opens a GX system compatible module (ASCII version).
bool	Open (gxInAStr modulename) throw (gxError)
	Opens a GX system compatible module with the default properties (ASCII version).
bool	Close (void) throw (gxError)
	Closes a previously opened module.
bool	IsValid (void) const
	Checks if the handle of the module is valid.
bool	GetInfo (const gxMODULEINFO **moduleinfo) throw (gxError)
	Gives information about an opened module.
bool	Call (int callcode, void *params)
	Calls a process of the module with its parameters.
bool	GetProperty (const wchar_t *name, wchar_t *string, int maxlen) throw (gxError)
	Gets a property of the specified module (Unicode version).
std::wstring	GetProperty (const wchar_t *name) throw (gxError)
	Gets a property of the specified module (Unicode version).
bool	GetProperty (const char *name, char *string, int maxlen) throw (gxError)
	Gets a property of the specified module (ASCII version).
std::string	GetProperty (const char *name) throw (gxError)
	Gets a property of the specified module (ASCII version).
gxOutStr	GetProperty (gxInStr name) throw (gxError)
	Gets a property of the specified module (Unicode version).
gxOutAStr	GetProperty (gxInAStr name) throw (gxError)
	Gets a property of the specified module (ASCII version).
bool	GetProperty (const wchar_t *name, int *ivalue) throw (gxError)
	Gets an integer property of the specified module (Unicode version).
bool	GetProperty (const char *name, int *ivalue) throw (gxError)
	Gets an integer property of the specified module (ASCII version).
bool	GetProperty (const wchar_t *name, double *fvalue) throw (gxError)
	Gets a floating-point property of the specified module (Unicode version).
bool	GetProperty (const char *name, double *fvalue) throw (gxError)
	Gets a floating-point property of the specified module (ASCII version).
int	GetPropertyInt (const wchar_t *name) throw (gxError)
	Gets an integer property of the specified module (Unicode version).
int	GetPropertyInt (gxInStr name) throw (gxError)
	Gets an integer property of the specified module (Unicode version).
int	GetPropertyInt (const char *name) throw (gxError)
	Gets an integer property of the specified module (ASCII version).
int	GetPropertyInt (gxInAStr name) throw (gxError)
	Gets an integer property of the specified module (ASCII version).
double	GetPropertyFloat (const wchar_t *name) throw (gxError)
	Gets a floating-point property of the specified module (Unicode version).
double	GetPropertyFloat (gxInStr name) throw (gxError)
	Gets a floating-point property of the specified module (Unicode version).
double	GetPropertyFloat (const char *name) throw (gxError)
	Gets a floating-point property of the specified module (ASCII version).
double	GetPropertyFloat (gxInAStr name) throw (gxError)
	Gets a floating-point property of the specified module (ASCII version).
bool	GetPropertyVersion (const wchar_t *name, unsigned int *version) throw (gxError)
	Gets a version property of the specified module (Unicode version).
unsigned int	GetPropertyVersion (const wchar_t *name) throw (gxError)
	Gets a version property of the specified module (Unicode version).
unsigned int	GetPropertyVersion (gxInStr name) throw (gxError)
	Gets a version property of the specified module (Unicode version).
bool	GetPropertyVersion (const char *name, unsigned int *version) throw (gxError)
	Gets a version property of the specified module (ASCII version).
unsigned int	GetPropertyVersion (const char *name) throw (gxError)
	Gets a version property of the specified module (ASCII version).
unsigned int	GetPropertyVersion (gxInAStr name) throw (gxError)
	Gets a version property of the specified module (ASCII version).
bool	SetProperty (const wchar_t *name, const wchar_t *string) throw (gxError)
	Sets a property of the specified module (Unicode version).
bool	SetProperty (const char *name, const char *string) throw (gxError)
	Sets a property of the specified module (ASCII version).
bool	SetProperty (gxInStr name, gxInStr str) throw (gxError)
	Sets a property of the specified module (Unicode version).
bool	SetProperty (gxInAStr name, gxInAStr str) throw (gxError)
	Sets a property of the specified module (ASCII version).
bool	SetProperty (const wchar_t *name, int ivalue) throw (gxError)
	Sets an integer property of the specified module (Unicode version).
bool	SetProperty (const char *name, int ivalue) throw (gxError)
	Sets an integer property of the specified module (ASCII version).
bool	SetProperty (gxInStr name, int ivalue) throw (gxError)
	Sets an integer property of the specified module (Unicode version).
bool	SetProperty (gxInAStr name, int ivalue) throw (gxError)
	Sets an integer property of the specified module (ASCII version).
bool	SetProperty (const wchar_t *name, double fvalue) throw (gxError)
	Sets a floating-point property of the specified module (Unicode version).
bool	SetProperty (const char *name, double fvalue) throw (gxError)
	Sets a floating-point property of the specified module (ASCII version).
bool	SetProperty (gxInStr name, double fvalue) throw (gxError)
	Sets a floating-point property of the specified module (Unicode version).
bool	SetProperty (gxInAStr name, double fvalue) throw (gxError)
	Sets a floating-point property of the specified module (ASCII version).
bool	SaveProperties (const wchar_t *name, int level=0) throw (gxError)
	Saves the properties of a module stored in the memory to a branch of the property tree stored on a mass storage device (Unicode version).
bool	SaveProperties (const char *name, int level=0) throw (gxError)
	Saves the properties of a module stored in the memory to a branch of the property tree stored on a mass storage device (ASCII version).
bool	SaveProperties (gxInStr name, int level) throw (gxError)
	Saves the properties of a module stored in the memory to a branch of the property tree stored on a mass storage device (Unicode version).
bool	SaveProperties (gxInStr name) throw (gxError)
	Saves the properties of a module stored in the memory to a branch of the property tree stored on a mass storage device (Unicode version).
bool	SaveProperties (gxInAStr name, int level=0) throw (gxError)
	Saves the properties of a module stored in the memory to a branch of the property tree stored on a mass storage device (ASCII version).
bool	MPStartTransaction (void)
	It starts the property transaction.
bool	MPCommit (void)
	It ends the property transaction and updates your changes to module.
Public Attributes
gxu32	handle
	Handle of the module.

---

Constructor & Destructor Documentation

gxMotionDetector

(

)

throw (gxError) [inline]

Class initialization.

References gx_openmodule().

gxMotionDetector	(	const wchar_t *	propname,
		const wchar_t *	modname = (const wchar_t *)0
	)			throw (gxError) [inline]

Class initialization with place of properties and name of the module (Unicode version).

Parameters:

	propname	Place of properties in the property tree (name of the property group).
	modname	Name of the module.

References gx_openmodule().

gxMotionDetector	(	const char *	propname,
		const char *	modname = (const char *)0
	)			throw (gxError) [inline]

Class initialization with place of properties and name of the module (ASCII version).

Parameters:

	propname	Place of properties in the property tree (name of the property group).
	modname	Name of the module.

References gx_openmodule().

gxMotionDetector	(	gxInStr	propname,
		gxInStr	modname
	)			throw (gxError) [inline]

Class initialization with place of properties and name of the module (Unicode version).

Parameters:

	propname	Place of properties in the property tree (name of the property group).
	modname	Name of the module.

References gx_openmodule().

gxMotionDetector

(

gxInStr

propname

)

throw (gxError) [inline]

Class initialization with place of properties (Unicode version).

Parameters:

propname

Place of properties in the property tree (name of the property group).

References gx_openmodule().

gxMotionDetector	(	gxInAStr	propname,
		gxInAStr	modname
	)			throw (gxError) [inline]

Class initialization with place of properties and name of the module (ASCII version).

Parameters:

	propname	Place of properties in the property tree (name of the property group).
	modname	Name of the module.

References gx_openmodule().

gxMotionDetector

(

gxInAStr

propname

)

throw (gxError) [inline]

Class initialization with place of properties (ASCII version).

Parameters:

propname

Place of properties in the property tree (name of the property group).

References gx_openmodule().

---

Member Function Documentation

bool Iteration	(	gxIMAGE *	image,
		int *	max_difference
	)			throw (gxError) [inline]

Adding a new image to the stream.

Warning:

The size of the image must be the same as given by the properties. GX_GRAY (8 bit grayscale), GX_RGB (24 bit RGB) and GX_BGR (24 bit BGR) pixel formats are allowed! In case of half frames use only the same field in one stream. For detecting motion on both odd and even fields, the using of two separated streams (opening twice the module) is recomended.

Parameters:

	image	Pointer to an image which represents the next still of the stream.
	max_difference	Pointer to an integer. The function updates it to the maximum of the blocks' pixel difference. If the image is the first still in the stream, -1 is returned.

Returns:

An exception is thrown or false is returned in case of error.

References gx_motdetiteration().

int Iteration

(

gxIMAGE *

image

)

throw (gxError) [inline]

Adding a new image to the stream.

Warning:

The size of the image must be the same as given by the properties. GX_GRAY (8 bit grayscale), GX_RGB (24 bit RGB) and GX_BGR (24 bit BGR) pixel formats are allowed! In case of half frames use only the same field in one stream. For detecting motion on both odd and even fields, the using of two separated streams (opening twice the module) is recomended.

Parameters:

image

Pointer to an image which represents the next still of the stream.

Returns:

The function returns the maximum of the blocks' pixel difference. If the image is the first still in the stream, -1 is returned.

int Iteration

(

gxImageData &

image

)

throw (gxError) [inline]

Adding a new image to the stream.

Warning:

The size of the image must be the same as given by the properties. GX_GRAY (8 bit grayscale), GX_RGB (24 bit RGB) and GX_BGR (24 bit BGR) pixel formats are allowed! In case of half frames use only the same field in one stream. For detecting motion on both odd and even fields, the using of two separated streams (opening twice the module) is recomended.

Parameters:

image

Pointer to an image which represents the next still of the stream.

Returns:

The function returns the maximum of the blocks' pixel difference. If the image is the first still in the stream, -1 is returned.

References gx_motdetiteration().

int Iteration

(

gxImage &

image

)

throw (gxError) [inline]

Adding a new image to the stream.

Warning:

The size of the image must be the same as given by the properties. GX_GRAY (8 bit grayscale), GX_RGB (24 bit RGB) and GX_BGR (24 bit BGR) pixel formats are allowed! In case of half frames use only the same field in one stream. For detecting motion on both odd and even fields, the using of two separated streams (opening twice the module) is recomended.

Parameters:

image

Pointer to an image which represents the next still of the stream.

Returns:

The function returns the maximum of the blocks' pixel difference. If the image is the first still in the stream, -1 is returned.

References gx_motdetiteration().

bool Iteration	(	gxIMAGE *	image,
		int *	max_difference,
		int *	min_difference,
		int *	found_x1,
		int *	found_y1,
		int *	found_x2,
		int *	found_y2
	)			throw (gxError) [inline]

Adding a new image to the stream.

Warning:

The size of the image must be the same as given by the properties. GX_GRAY (8 bit grayscale), GX_RGB (24 bit RGB) and GX_BGR (24 bit BGR) pixel formats are allowed! In case of half frames use only the same field in one stream. For detecting motion on both odd and even fields, the using of two separated streams (opening twice the module) is recomended.

Parameters:

	image	Pointer to an image which represents the next still of the stream.
	min_difference	Pointer to an integer. The function updates it to the minimum of the blocks' pixel difference. If the image is the first still in the stream, -1 is returned. This pointer can be NULL.
	max_difference	Pointer to an integer. The function updates it to the maximum of the blocks' pixel difference. If the image is the first still in the stream, -1 is returned. This pointer can be NULL.
	found_x1	Pointer to an integer. The function updates it to the left upper horizontal coordinate of the founded area. If the image is the first still in the stream, it will be undefined. This pointer can be NULL.
	found_y1	Pointer to an integer. The function updates it to the left upper vertical coordinate of the founded area. If the image is the first still in the stream, it will be undefined. This pointer can be NULL.
	found_x2	Pointer to an integer. The function updates to the right lower horizontal coordinate of the founded area. If the image is the first still in the stream, it will be undefined. This pointer can be NULL.
	found_y2	Pointer to an integer. The function updates it to the right lower vertical coordinate of the founded area. If the image is the first still in the stream, it will be undefined. This pointer can be NULL.

Returns:

An exception is thrown or false is returned in case of error.

References gx_motdetiteration().

bool Iteration	(	gxIMAGE *	image,
		gxMotionDetectorResult &	result
	)			throw (gxError) [inline]

Adding a new image to the stream.

Warning:

The size of the image must be the same as given by the properties. GX_GRAY (8 bit grayscale), GX_RGB (24 bit RGB) and GX_BGR (24 bit BGR) pixel formats are allowed! In case of half frames use only the same field in one stream. For detecting motion on both odd and even fields, the using of two separated streams (opening twice the module) is recomended.

Parameters:

	image	Pointer to an image which represents the next still of the stream.
	result	The result structure which the function will updates it.

Returns:

An exception is thrown or false is returned in case of error.

References gx_motdetiteration().

bool Iteration	(	gxImageData &	image,
		gxMotionDetectorResult &	result
	)			throw (gxError) [inline]

Adding a new image to the stream.

Warning:

The size of the image must be the same as given by the properties. GX_GRAY (8 bit grayscale), GX_RGB (24 bit RGB) and GX_BGR (24 bit BGR) pixel formats are allowed! In case of half frames use only the same field in one stream. For detecting motion on both odd and even fields, the using of two separated streams (opening twice the module) is recomended.

Parameters:

	image	Pointer to an image which represents the next still of the stream.
	result	The result structure which the function will updates it.

Returns:

An exception is thrown or false is returned in case of error.

References gx_motdetiteration().

bool Iteration	(	gxImage &	image,
		gxMotionDetectorResult &	result
	)			throw (gxError) [inline]

Adding a new image to the stream.

Warning:

The size of the image must be the same as given by the properties. GX_GRAY (8 bit grayscale), GX_RGB (24 bit RGB) and GX_BGR (24 bit BGR) pixel formats are allowed! In case of half frames use only the same field in one stream. For detecting motion on both odd and even fields, the using of two separated streams (opening twice the module) is recomended.

Parameters:

	image	Pointer to an image which represents the next still of the stream.
	result	The result structure which the function will updates it.

Returns:

An exception is thrown or false is returned in case of error.

References gx_motdetiteration().

void Dispose

(

void

)

[inline, inherited]

It disposes the class.

no base class.

Reimplemented in gxImage, gxLog, and gxTrafo.

Referenced by gxTrafo::Dispose(), gxLog::Dispose(), and gxImage::Dispose().

bool Open	(	const wchar_t *	modulename,
		const wchar_t *	groupname = (const wchar_t *)0
	)			throw (gxError) [inline, inherited]

Opens a GX system compatible module (Unicode version).

Parameters:

	modulename	Name of the module.
	groupname	Property place in the property tree.

Returns:

An exception is thrown or false is returned in case of error.

References gx_openmodule().

bool Open	(	const char *	modulename,
		const char *	groupname = (const char *)0
	)			throw (gxError) [inline, inherited]

Opens a GX system compatible module (ASCII version).

Parameters:

	modulename	Name of the module.
	groupname	Property place in the property tree.

Returns:

An exception is thrown or false is returned in case of error.

References gx_openmodule().

bool Open	(	gxInStr	modulename,
		gxInStr	groupname
	)			throw (gxError) [inline, inherited]

Opens a GX system compatible module (Unicode version).

Parameters:

	modulename	Name of the module.
	groupname	Property place in the property tree.

Returns:

An exception is thrown or false is returned in case of error.

References gx_openmodule().

bool Open

(

gxInStr

modulename

)

throw (gxError) [inline, inherited]

Opens a GX system compatible module with the default properties (Unicode version).

Parameters:

modulename

Name of the module.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxGZip, and gxZip.

References gx_openmodule().

bool Open	(	gxInAStr	modulename,
		gxInAStr	groupname
	)			throw (gxError) [inline, inherited]

Opens a GX system compatible module (ASCII version).

Parameters:

	modulename	Name of the module.
	groupname	Property place in the property tree.

Returns:

An exception is thrown or false is returned in case of error.

References gx_openmodulea().

bool Open

(

gxInAStr

modulename

)

throw (gxError) [inline, inherited]

Opens a GX system compatible module with the default properties (ASCII version).

Parameters:

modulename

Name of the module.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxGZip, and gxZip.

References gx_openmodulea().

bool Close

(

void

)

throw (gxError) [inline, inherited]

Closes a previously opened module.

It decreases the reference counter of the handle. The function closes the module if required (in case when the reference counter becames zero).

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxGZip, and gxZip.

References gx_unrefhandle(), and gxHandle::IsValid().

Referenced by gxHandle::operator=().

bool IsValid

(

void

)

const [inline, inherited]

Checks if the handle of the module is valid.

Returns:

In case of existing handle the return value is true.

Reimplemented in gxImage, gxTrafo, gxGZip, and gxZip.

Referenced by gxHandle::Close(), gxHandle::gxHandle(), gxImage::gxImage(), gxTrafo::gxTrafo(), gxZip::IsValid(), gxGZip::IsValid(), gxTrafo::IsValid(), and gxImage::IsValid().

bool GetInfo

(

const gxMODULEINFO **

moduleinfo

)

throw (gxError) [inline, inherited]

Gives information about an opened module.

Parameters:

moduleinfo

Pointer to an information structure pointer where the system returns the data of the specified module.

Returns:

An exception is thrown or false is returned in case of error.

References gx_getmoduleinfo().

bool Call	(	int	callcode,
		void *	params
	)			[inline, inherited]

Calls a process of the module with its parameters.

The functions and parameters usable inside the modules can be found in the documentation of the modules. The headers given with the modules contain inline functions, which make easier to access the functions of the module.

Parameters:

	callcode	Call code for the function (GX_CALL_xxx call codes).
	params	Parameters to give for the function (GX_PARM_xxx structures).

Returns:

Module defined, usually success is true.

References gx_call().

bool GetProperty	(	const wchar_t *	name,
		wchar_t *	string,
		int	maxlen
	)			throw (gxError) [inline, inherited]

Gets a property of the specified module (Unicode version).

Parameters:

	name	Name of the property.
	string	Pointer to a memory area where to store the value.
	maxlen	Size of memory area in characters (not bytes).

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_getmoduleproperty().

std::wstring GetProperty

(

const wchar_t *

name

)

throw (gxError) [inline, inherited]

Gets a property of the specified module (Unicode version).

Parameters:

name

Name of the property.

Returns:

Value of the property or an exception is thrown in case of error.

Reimplemented in gxProperty.

References gx_getmoduleproperty().

bool GetProperty	(	const char *	name,
		char *	string,
		int	maxlen
	)			throw (gxError) [inline, inherited]

Gets a property of the specified module (ASCII version).

Parameters:

	name	Name of the property.
	string	Pointer to a memory area where to store the value.
	maxlen	Size of memory area in characters (not bytes).

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_getmoduleproperty().

std::string GetProperty

(

const char *

name

)

throw (gxError) [inline, inherited]

Gets a property of the specified module (ASCII version).

Parameters:

name

Name of the property.

Returns:

Value of the property or an exception is thrown in case of error.

Reimplemented in gxProperty.

References gx_getmoduleproperty().

gxOutStr GetProperty

(

gxInStr

name

)

throw (gxError) [inline, inherited]

Gets a property of the specified module (Unicode version).

Parameters:

name

Name of the property.

Returns:

Value of the property or an exception is thrown in case of error.

Reimplemented in gxProperty.

References gx_getmoduleproperty().

gxOutAStr GetProperty

(

gxInAStr

name

)

throw (gxError) [inline, inherited]

Gets a property of the specified module (ASCII version).

Parameters:

name

Name of the property.

Returns:

Value of the property or an exception is thrown in case of error.

Reimplemented in gxProperty.

References gx_getmodulepropertya().

bool GetProperty	(	const wchar_t *	name,
		int *	ivalue
	)			throw (gxError) [inline, inherited]

Gets an integer property of the specified module (Unicode version).

Parameters:

	name	Name of the property.
	ivalue	Pointer to an integer where to store the value.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_getmodulepropertyint().

bool GetProperty	(	const char *	name,
		int *	ivalue
	)			throw (gxError) [inline, inherited]

Gets an integer property of the specified module (ASCII version).

Parameters:

	name	Name of the property.
	ivalue	Pointer to an integer where to store the value.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_getmodulepropertyinta().

bool GetProperty	(	const wchar_t *	name,
		double *	fvalue
	)			throw (gxError) [inline, inherited]

Gets a floating-point property of the specified module (Unicode version).

Parameters:

	name	Name of the property.
	fvalue	Pointer to a floating-point where to store the value.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_getmodulepropertyfloat().

bool GetProperty	(	const char *	name,
		double *	fvalue
	)			throw (gxError) [inline, inherited]

Gets a floating-point property of the specified module (ASCII version).

Parameters:

	name	Name of the property.
	fvalue	Pointer to a floating-point where to store the value.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_getmodulepropertyfloata().

int GetPropertyInt

(

const wchar_t *

name

)

throw (gxError) [inline, inherited]

Gets an integer property of the specified module (Unicode version).

Parameters:

name

Name of the property.

Returns:

The integer value of the property or an exception is thrown in case of error.

References gx_getmodulepropertyint().

int GetPropertyInt

(

gxInStr

name

)

throw (gxError) [inline, inherited]

Gets an integer property of the specified module (Unicode version).

Parameters:

name

Name of the property.

Returns:

The integer value of the property or an exception is thrown in case of error.

Reimplemented in gxProperty.

References gx_getmodulepropertyint().

int GetPropertyInt

(

const char *

name

)

throw (gxError) [inline, inherited]

Gets an integer property of the specified module (ASCII version).

Parameters:

name

Name of the property.

Returns:

The integer value of the property or an exception is thrown in case of error.

References gx_getmodulepropertyinta().

int GetPropertyInt

(

gxInAStr

name

)

throw (gxError) [inline, inherited]

Gets an integer property of the specified module (ASCII version).

Parameters:

name

Name of the property.

Returns:

The integer value of the property or an exception is thrown in case of error.

Reimplemented in gxProperty.

References gx_getmodulepropertyinta().

double GetPropertyFloat

(

const wchar_t *

name

)

throw (gxError) [inline, inherited]

Gets a floating-point property of the specified module (Unicode version).

Parameters:

name

Name of the property.

Returns:

The floating-point value of the property or an exception is thrown in case of error.

References gx_getmodulepropertyfloat().

double GetPropertyFloat

(

gxInStr

name

)

throw (gxError) [inline, inherited]

Gets a floating-point property of the specified module (Unicode version).

Parameters:

name

Name of the property.

Returns:

The floating-point value of the property or an exception is thrown in case of error.

Reimplemented in gxProperty.

References gx_getmodulepropertyfloat().

double GetPropertyFloat

(

const char *

name

)

throw (gxError) [inline, inherited]

Gets a floating-point property of the specified module (ASCII version).

Parameters:

name

Name of the property.

Returns:

The floating-point value of the property or an exception is thrown in case of error.

References gx_getmodulepropertyfloata().

double GetPropertyFloat

(

gxInAStr

name

)

throw (gxError) [inline, inherited]

Gets a floating-point property of the specified module (ASCII version).

Parameters:

name

Name of the property.

Returns:

The floating-point value of the property or an exception is thrown in case of error.

Reimplemented in gxProperty.

References gx_getmodulepropertyfloata().

bool GetPropertyVersion	(	const wchar_t *	name,
		unsigned int *	version
	)			throw (gxError) [inline, inherited]

Gets a version property of the specified module (Unicode version).

Parameters:

	name	Name of the property.
	version	Pointer to an integer where to store the version.

Returns:

An exception is thrown or false is returned in case of error.

References gx_getmodulepropertyversion().

unsigned int GetPropertyVersion

(

const wchar_t *

name

)

throw (gxError) [inline, inherited]

Gets a version property of the specified module (Unicode version).

Parameters:

name

Name of the property.

Returns:

The integer value of the property or an exception is thrown in case of error.

References gx_getmodulepropertyversion().

unsigned int GetPropertyVersion

(

gxInStr

name

)

throw (gxError) [inline, inherited]

Gets a version property of the specified module (Unicode version).

Parameters:

name

Name of the property.

Returns:

The integer value of the property or an exception is thrown in case of error.

References gx_getmodulepropertyversion().

bool GetPropertyVersion	(	const char *	name,
		unsigned int *	version
	)			throw (gxError) [inline, inherited]

Gets a version property of the specified module (ASCII version).

Parameters:

	name	Name of the property.
	version	Pointer to an integer where to store the version.

Returns:

An exception is thrown or false is returned in case of error.

References gx_getmodulepropertyversiona().

unsigned int GetPropertyVersion

(

const char *

name

)

throw (gxError) [inline, inherited]

Gets a version property of the specified module (ASCII version).

Parameters:

name

Name of the property.

Returns:

The integer value of the property or an exception is thrown in case of error.

References gx_getmodulepropertyversiona().

unsigned int GetPropertyVersion

(

gxInAStr

name

)

throw (gxError) [inline, inherited]

Gets a version property of the specified module (ASCII version).

Parameters:

name

Name of the property.

Returns:

The integer value of the property or an exception is thrown in case of error.

References gx_getmodulepropertyversiona().

bool SetProperty	(	const wchar_t *	name,
		const wchar_t *	string
	)			throw (gxError) [inline, inherited]

Sets a property of the specified module (Unicode version).

Parameters:

	name	Name of the property.
	string	Value of the property.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_setmoduleproperty().

bool SetProperty	(	const char *	name,
		const char *	string
	)			throw (gxError) [inline, inherited]

Sets a property of the specified module (ASCII version).

Parameters:

	name	Name of the property.
	string	Value of the property.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_setmodulepropertya().

bool SetProperty	(	gxInStr	name,
		gxInStr	str
	)			throw (gxError) [inline, inherited]

Sets a property of the specified module (Unicode version).

Parameters:

	name	Name of the property.
	str	Value of the property.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_setmoduleproperty().

bool SetProperty	(	gxInAStr	name,
		gxInAStr	str
	)			throw (gxError) [inline, inherited]

Sets a property of the specified module (ASCII version).

Parameters:

	name	Name of the property.
	str	Value of the property.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_setmodulepropertya().

bool SetProperty	(	const wchar_t *	name,
		int	ivalue
	)			throw (gxError) [inline, inherited]

Sets an integer property of the specified module (Unicode version).

Parameters:

	name	Name of the property.
	ivalue	An integer value of the property.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_setmodulepropertyint().

bool SetProperty	(	const char *	name,
		int	ivalue
	)			throw (gxError) [inline, inherited]

Sets an integer property of the specified module (ASCII version).

Parameters:

	name	Name of the property.
	ivalue	An integer value of the property.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_setmodulepropertyinta().

bool SetProperty	(	gxInStr	name,
		int	ivalue
	)			throw (gxError) [inline, inherited]

Sets an integer property of the specified module (Unicode version).

Parameters:

	name	Name of the property.
	ivalue	An integer value of the property.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_setmodulepropertyint().

bool SetProperty	(	gxInAStr	name,
		int	ivalue
	)			throw (gxError) [inline, inherited]

Sets an integer property of the specified module (ASCII version).

Parameters:

	name	Name of the property.
	ivalue	An integer value of the property.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_setmodulepropertyinta().

bool SetProperty	(	const wchar_t *	name,
		double	fvalue
	)			throw (gxError) [inline, inherited]

Sets a floating-point property of the specified module (Unicode version).

Parameters:

	name	Name of the property.
	fvalue	A floating-point value of the property.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_setmodulepropertyfloat().

bool SetProperty	(	const char *	name,
		double	fvalue
	)			throw (gxError) [inline, inherited]

Sets a floating-point property of the specified module (ASCII version).

Parameters:

	name	Name of the property.
	fvalue	A floating-point value of the property.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_setmodulepropertyfloata().

bool SetProperty	(	gxInStr	name,
		double	fvalue
	)			throw (gxError) [inline, inherited]

Sets a floating-point property of the specified module (Unicode version).

Parameters:

	name	Name of the property.
	fvalue	A floating-point value of the property.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_setmodulepropertyfloat().

bool SetProperty	(	gxInAStr	name,
		double	fvalue
	)			throw (gxError) [inline, inherited]

Sets a floating-point property of the specified module (ASCII version).

Parameters:

	name	Name of the property.
	fvalue	A floating-point value of the property.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_setmodulepropertyfloata().

bool SaveProperties	(	const wchar_t *	name,
		int	level = 0
	)			throw (gxError) [inline, inherited]

Saves the properties of a module stored in the memory to a branch of the property tree stored on a mass storage device (Unicode version).

Parameters:

	name	Place of property in the tree.
	level	Higher numbers give more details (0 = basic properties, 100 = all properties).

Returns:

An exception is thrown or false is returned in case of error.

References gx_savemoduleproperties().

bool SaveProperties	(	const char *	name,
		int	level = 0
	)			throw (gxError) [inline, inherited]

Saves the properties of a module stored in the memory to a branch of the property tree stored on a mass storage device (ASCII version).

Parameters:

	name	Place of property in the tree.
	level	Higher numbers give more details (0 = basic properties, 100 = all properties).

Returns:

An exception is thrown or false is returned in case of error.

References gx_savemoduleproperties().

bool SaveProperties	(	gxInStr	name,
		int	level
	)			throw (gxError) [inline, inherited]

Saves the properties of a module stored in the memory to a branch of the property tree stored on a mass storage device (Unicode version).

Parameters:

	name	Place of property in the tree.
	level	Higher numbers give more details (0 = basic properties, 100 = all properties).

Returns:

An exception is thrown or false is returned in case of error.

References gx_savemoduleproperties().

bool SaveProperties

(

gxInStr

name

)

throw (gxError) [inline, inherited]

Saves the properties of a module stored in the memory to a branch of the property tree stored on a mass storage device (Unicode version).

Parameters:

name

Place of property in the tree.

Returns:

An exception is thrown or false is returned in case of error.

References gx_savemoduleproperties().

bool SaveProperties	(	gxInAStr	name,
		int	level = 0
	)			throw (gxError) [inline, inherited]

Saves the properties of a module stored in the memory to a branch of the property tree stored on a mass storage device (ASCII version).

Parameters:

	name	Place of property in the tree.
	level	Higher numbers give more details (0 = basic properties, 100 = all properties).

Returns:

An exception is thrown or false is returned in case of error.

References gx_savemodulepropertiesa().

bool MPStartTransaction

(

void

)

[inline, inherited]

It starts the property transaction.

The module accepts but doesn't update properties (setmoduleproperty). You must use 'gx_mpcommit' to update these properties.

Warning:

Not supported by each module!

Returns:

An exception is thrown or false is returned in case of error.

References gx_mpstarttransaction().

bool MPCommit

(

void

)

[inline, inherited]

It ends the property transaction and updates your changes to module.

Warning:

Not supported by each module!

Returns:

An exception is thrown or false is returned in case of error.

References gx_mpcommit().

---

Member Data Documentation

gxu32 handle [inherited]

Handle of the module.

If it is zero, it is invalid.

See also:

gx_isvalidhandle()

Referenced by gx_closehandle(), gx_direct(), gx_isvalidhandle(), gxHandle::gxHandle(), gxImageHandler::gxImageHandler(), gxTrafoHandler::gxTrafoHandler(), and gxHandle::operator=().