prImage Class Reference

List of all members.

---

Detailed Description

This class represents a captured image in the PR system.

Public Member Functions
	~prImage () throw (gxError)
	Destructor.
void	Dispose (void)
	Disposes the class.
	operator gxVARIANT () const
	Returns a pointer to the image structure of the class.
	prImage (gxVARIANT src) throw (gxError)
	Class initialization with an existing image structure.
bool	Attach (gxVARIANT src) throw (gxError)
	Attaches to an existing image structure.
bool	Attach (prImage &src) throw (gxError)
	Attaches to an existing image structure.
bool	Detach (void) throw (gxError)
	Detaches the previously attached image.
gxIMAGE *	GxImage (void) const throw (gxError)
	Returns the gxIMAGE structure element of the image.
const gxTRAFO *	Trafo (void) const throw (gxError)
	Returns the gxTRAFO structure element of the image.
int	CaptureTime (void) const throw (gxError)
	Returns the capture time of the image.
int	Page (void) const throw (gxError)
	Returns the page number of the image.
int	Page (int page) throw (gxError)
	Sets the page number of the image.
int	Light (void) const throw (gxError)
	Returns the light id of the image.
int	Camera (void) const throw (gxError)
	Returns the camera id of the image.
bool	IsValid (void) const
	Checks if the image structure and handle is valid.

---

Constructor & Destructor Documentation

~prImage

(

)

throw (gxError) [inline]

Destructor.

prImage

(

gxVARIANT

src

)

throw (gxError) [inline]

Class initialization with an existing image structure.

Parameters:

src

Pointer to an existing image structure.

References gx_refvariant().

---

Member Function Documentation

void Dispose

(

void

)

[inline]

Disposes the class.

operator gxVARIANT

(

)

const [inline]

Returns a pointer to the image structure of the class.

Returns:

If the class contains valid image data the function returns its reference. In the other case 0 is returned.

bool Attach

(

gxVARIANT

src

)

throw (gxError) [inline]

Attaches to an existing image structure.

Parameters:

src

An existing image structure.

Returns:

On success: non-zero ( see gx_geterror() )

References gx_poperror(), gx_pusherror(), gx_refvariant(), and gx_unrefvariant().

bool Attach

(

prImage &

src

)

throw (gxError) [inline]

Attaches to an existing image structure.

Parameters:

src

An existing image structure.

Returns:

On success: non-zero ( see gx_geterror() )

References gx_poperror(), gx_pusherror(), gx_refvariant(), and gx_unrefvariant().

bool Detach

(

void

)

throw (gxError) [inline]

Detaches the previously attached image.

Returns:

Upon success: non-zero ( see gx_geterror() )

References gx_unrefvariant().

gxIMAGE* GxImage

(

void

)

const throw (gxError) [inline]

Returns the gxIMAGE structure element of the image.

Returns:

If an image is attached to the class the function returns its gxIMAGE element. If there is no image attached it returns 0.

References gx_imagefromvariant().

const gxTRAFO* Trafo

(

void

)

const throw (gxError) [inline]

Returns the gxTRAFO structure element of the image.

Returns:

If an image is attached to the class the function returns one of its gxTRAFO element. If there is no image attached it returns 0.

References gx_getvariantchild(), gx_poperror(), gx_pusherror(), gx_trafofromvariant(), gx_unrefvariant(), and PRV_TRAFO.

int CaptureTime

(

void

)

const throw (gxError) [inline]

Returns the capture time of the image.

Returns:

If an image is attached to the class the function returns its capture time. If there is no image attached it returns 0.

References gx_convertvariantchild(), GX_VARIANT_INT, and PRV_CAPTIME.

int Page

(

void

)

const throw (gxError) [inline]

Returns the page number of the image.

Returns:

If an image is attached to the class the function returns its page number. If there is no image attached it returns 0.

References gx_convertvariantchild(), GX_VARIANT_INT, and PRV_PAGE.

int Page

(

int

page

)

throw (gxError) [inline]

Sets the page number of the image.

Parameters:

page

The new page number.

Returns:

The new page number.

References gx_getvariantchild(), gx_poperror(), gx_pusherror(), gx_unrefvariant(), gx_updatevariantdata(), GX_VARIANT_INT, and PRV_PAGE.

int Light

(

void

)

const throw (gxError) [inline]

Returns the light id of the image.

Returns:

If an image is attached to the class the function returns its light settings. The available light values are defined in PR_LIGHT enumeration. If there is no image attached the function returns 0.

References gx_convertvariantchild(), GX_VARIANT_INT, and PRV_LIGHT.

int Camera

(

void

)

const throw (gxError) [inline]

Returns the camera id of the image.

Returns:

If an image is attached to the class the function returns its camera id number. If there is no image attached it returns 0.

References gx_convertvariantchild(), GX_VARIANT_INT, and PRV_CAMERA.

bool IsValid

(

void

)

const [inline]

Checks if the image structure and handle is valid.

Returns:

In case of valid image the return value is true.