WizardItem Class Reference

A single wizard task. More...

#include <WizardItem.h>

Inheritance diagram for WizardItem:

List of all members.

Public Member Functions
virtual const std::string &	getName () const =0
virtual const std::string &	getType () const =0
virtual bool	getBatchMode () const =0
virtual bool	isCurrentModeSupported () const =0
virtual WizardNode *	getInputNode (const std::string &name, const std::string &type) const =0
virtual const std::vector < WizardNode * > &	getInputNodes () const =0
virtual WizardNode *	getOutputNode (const std::string &name, const std::string &type) const =0
virtual const std::vector < WizardNode * > &	getOutputNodes () const =0
virtual bool	isItemConnected (WizardItem *pItem, bool bInputNode) const =0
virtual void	getConnectedItems (bool bInputNode, std::vector< WizardItem * > &connectedItems) const =0
virtual WizardObject *	getWizard ()=0
virtual const WizardObject *	getWizard () const =0
Protected Member Functions
virtual	~WizardItem ()

---

Detailed Description

A single wizard task.

A WizardItem object defines a single task that is executed from within a wizard. The item has a name and a type for the unique identifiers. The available types are as follows:

Type	Description
Algorithm	A plug-in typically used for processing data.
Exporter	A plug-in to save data to a file.
Georeference	A georeferencing algorithm.
Importer	A plug-in to load data from a file.
Value	A specific data value that is stored as a DataVariant.
Viewer	A plug-in to uniquely display data.
Wizard	A plug-in used to execute other plug-ins and services. Many of these items allow for a run-time selection and execution of a method in the DesktopServices interface.

An item is designated to run either in batch mode or interactive mode. The getBatchMode() method queries this state.

The item contains input and output nodes that define the required input data and the generated output data. The nodes can be retrieved using getInputNodes() and getOutputNodes() or with getInputNode() and getOutputNode() if the name and type of the node are known.

See also:

WizardNode

Definition at line 51 of file WizardItem.h.

---

Constructor & Destructor Documentation

virtual WizardItem::~WizardItem

(

)

[protected, virtual]

A plug-in cannot create this object; it can only retrieve an already existing object from WizardObject.

The WizardObject will manage any instances of this object.

Definition at line 192 of file WizardItem.h.

---

Member Function Documentation

virtual const std::string& WizardItem::getName

(

)

const [pure virtual]

Returns the item name.

Returns:

The item name.

See also:

getType()

virtual const std::string& WizardItem::getType

(

)

const [pure virtual]

Returns the item type.

Returns:

The item type.

See also:

getName()

virtual bool WizardItem::getBatchMode

(

)

const [pure virtual]

Returns the batch mode operation state of the item.

Returns:

TRUE if the item is set to run in batch mode. FALSE if the item is set to run in interactive mode.

virtual bool WizardItem::isCurrentModeSupported

(

)

const [pure virtual]

Returns whether the item supports the current batch/interactive mode.

Returns:

TRUE if the item supports the current mode. FALSE if the item does not support the current mode.

See also:

getBatchMode()

virtual WizardNode* WizardItem::getInputNode	(	const std::string &	name,
		const std::string &	type
	)			const [pure virtual]

Retrieves a single input node.

Parameters:

	name	The input node name.
	type	The input node type.

Returns:

A pointer to the input node. NULL is returned if no input node exists with the given name and type.

See also:

getInputNodes(), getOutputNode()

virtual const std::vector<WizardNode*>& WizardItem::getInputNodes

(

)

const [pure virtual]

Retrieves all input nodes.

Returns:

A reference to a vector containing the input node pointers.

See also:

getInputNode(), getOutputNodes()

virtual WizardNode* WizardItem::getOutputNode	(	const std::string &	name,
		const std::string &	type
	)			const [pure virtual]

Retrieves a single output node.

Parameters:

	name	The output node name.
	type	The output node type.

Returns:

A pointer to the output node. NULL is returned if no output node exists with the given name and type.

See also:

getOutputNodes(), getInputNode()

virtual const std::vector<WizardNode*>& WizardItem::getOutputNodes

(

)

const [pure virtual]

Retrieves all output nodes.

Returns:

A reference to a vector containing the output node pointers.

See also:

getOutputNode(), getInputNodes()

virtual bool WizardItem::isItemConnected	(	WizardItem *	pItem,
		bool	bInputNode
	)			const [pure virtual]

Queries whether an item is directly or indirectly connected to this item.

This method provides a recursive search for the connected item by searching the entire chain of items connected to the reference item. The input flag specifies whether to search the chain of input node or output node connections.

Parameters:

	pItem	The item to query for a connection
	bInputNode	TRUE to search items connected to the input nodes and FALSE to search items connected to the output nodes.

Returns:

TRUE if the item is connected. FALSE if the item is not connected or the item does not exist.

See also:

getConnectedItems()

virtual void WizardItem::getConnectedItems	(	bool	bInputNode,
		std::vector< WizardItem * > &	connectedItems
	)			const [pure virtual]

Retrieves wizard items connected to the input or output nodes of this item.

Parameters:

	bInputNode	TRUE to return items connected to the input nodes and FALSE to return items connected to the output nodes.
	connectedItems	A vector that is populated with pointers to the wizard items connected with this one.

See also:

isItemConnected()

virtual WizardObject* WizardItem::getWizard

(

)

[pure virtual]

Returns the parent wizard containing this item.

Returns:

The parent wizard.

virtual const WizardObject* WizardItem::getWizard

(

)

const [pure virtual]

Returns the parent wizard containing this item.

Returns:

The parent wizard.