GeoreferenceShell Class Reference
[Plug-In Shells]

#include <GeoreferenceShell.h>

Inheritance diagram for GeoreferenceShell:

List of all members.

Public Member Functions
	GeoreferenceShell ()
	~GeoreferenceShell ()
bool	getInputSpecification (PlugInArgList *&pArgList)
bool	getOutputSpecification (PlugInArgList *&pArgList)
LocationType	pixelToGeoQuick (LocationType pixel, bool *pAccurate=NULL) const
LocationType	geoToPixelQuick (LocationType geo, bool *pAccurate=NULL) const
QWidget *	getGui (RasterElement *pRaster)
bool	validateGuiInput () const

---

Detailed Description

Definition at line 20 of file GeoreferenceShell.h.

---

Constructor & Destructor Documentation

GeoreferenceShell::GeoreferenceShell

(

)

Creates a georeference plug-in.

The constructor sets the plug-in type to PlugInManagerServices::GeoreferenceType() and sets the plug-in to allow multiple instances.

See also:

getType(), areMultipleInstancesAllowed()

GeoreferenceShell::~GeoreferenceShell

(

)

Destroys the georeference plug-in.

---

Member Function Documentation

bool GeoreferenceShell::getInputSpecification

(

PlugInArgList *&

pArgList

)

[virtual]

Retrieves the plug-in input parameters.

This method queries the plug-in for its input parameters that are needed to execute properly. The input arguments may be different in interactive mode and batch mode.

Parameters:

pArgList

A plug-in arg list pointer that is set to a created input argument list specifying the plug-in input parameters. NULL is a valid pointer value if the plug-in does not require any input arguments.

Returns:

Returns true if the input parameter argument list was successfully created. If the plug-in does not require input arguments, true is returned, but the given plug-in arg list pointer may be NULL.

See also:

PlugInArgList

Default Implementation:

The default implementation adds the following args:

Name	Type
Raster Element	RasterElement
Progress	Progress

Implements Executable.

bool GeoreferenceShell::getOutputSpecification

(

PlugInArgList *&

pArgList

)

[virtual]

Retrieves the plug-in output parameters.

This method queries the plug-in for its output parameters that are created during execution. The output arguments may be different in interactive mode and batch mode.

Parameters:

pArgList

A plug-in arg list pointer that is set to a created output argument list specifying the plug-in output parameters. NULL is a valid pointer value if the plug-in does not provide any output arguments.

Returns:

Returns true if the output parameter argument list was successfully created. If the plug-in does not provide output arguments, true is returned, but the given plug-in arg list pointer may be NULL.

See also:

PlugInArgList

Default Implementation:

The default implementation does not set any args in the arg list and returns true.

Implements Executable.

LocationType GeoreferenceShell::pixelToGeoQuick	(	LocationType	pixel,
		bool *	pAccurate = NULL
	)			const [virtual]

Takes a scene pixel coordinate and returns the approximate corresponding geocoordinate value.

This function will accomplish the goal faster than pixelToGeo() if possible.

Parameters:

	pixel	The scene pixel location as a LocationType
	pAccurate	Output indicator of conversion accuracy. Georeference plug-ins that can not accurately extrapolate should return false when pixel is outside the extents of the reference points. When NULL, no accuracy check is performed.

Returns:

The corresponding geocoordinate as a LocationType.

Default Implementation:

The default implementation calls pixelToGeo().

Implements Georeference.

LocationType GeoreferenceShell::geoToPixelQuick	(	LocationType	geo,
		bool *	pAccurate = NULL
	)			const [virtual]

Takes a and returns the approximate corresponding geocoordinate scene pixel coordinate value.

This function will accomplish the goal faster than pixelToGeo() if possible.

Parameters:

	geo	The geocoordinate location as a LocationType
	pAccurate	Output indicator of conversion accuracy. Georeference plug-ins that can not accurately extrapolate should return false when geo is outside the extents of the reference points. When NULL, no accuracy check is performed.

Returns:

The corresponding pixel as a LocationType.

Default Implementation:

The default implementation calls geoToPixel().

Implements Georeference.

QWidget* GeoreferenceShell::getGui

(

RasterElement *

pRaster

)

[virtual]

Gets a QWidget to set all parameters needed by the georeferencing algorithm.

The calling method takes ownership of the returned widget. The returned widget may be destroyed at any time after calling Executable::execute() on the plug-in.

Parameters:

pRaster

The RasterElement to create the GUI for.

Returns:

The widget with any appropriate controls, or NULL if interactive mode is not supported or no controls are needed.

Default Implementation:

The default implementation returns NULL.

Implements Georeference.

bool GeoreferenceShell::validateGuiInput

(

)

const [virtual]

Determines if the user input through the GUI is valid.

Returns:

Returns true if the input is valid, otherwise returns false.

See also:

getGui()

Default Implementation:

The default implementation returns true.

Implements Georeference.