NSEvaluation::PluginItem Class Reference

The base for the evaluationchain. More...

#include <evaluationpath_items.h>

Inheritance diagram for NSEvaluation::PluginItem:

Collaboration diagram for NSEvaluation::PluginItem:

[legend]

List of all members.

Signals
void	sExecAdd (NSCore::QTreeItem *, NSCore::GuiServer_Interface *)
void	sExecRemove (NSCore::QTreeItem *, NSCore::GuiServer_Interface *)
Public Member Functions
	~PluginItem ()
	destructor
virtual void	process (NSCore::AcqisitionDataSet &)
	process data
virtual QString	type () const =0
virtual QString	name () const =0
virtual QString	help () const
virtual NSCore::NamedParameterTreeItemPointer	config ()=0
	Give access to the configuration.
QStringList	guiActions () const
	GUI: return the supported actions.
void	guiExecAction (QString action, NSCore::GuiServer_Interface *gui)
	GUI: execute the named action.
QString	guiString () const
Protected Member Functions
	PluginItem (PluginItem *p=0)
	constructor
	PluginItem (QString n, QTreeItem *p)
	constructor
QString	debug () const
	debug...
bool	createFromXML (QDomNode node)
	Create childs from XML.

---

Detailed Description

The base for the evaluationchain.

This class is the base for a tree to do evaluation on the datasets.

---

Constructor & Destructor Documentation

NSEvaluation::PluginItem::PluginItem

(

PluginItem *

p = 0

)

[inline, protected]

constructor

NSEvaluation::PluginItem::PluginItem	(	QString	n,
		QTreeItem *	p
	)			[inline, protected]

constructor

NSEvaluation::PluginItem::~PluginItem

(

)

[inline]

destructor

---

Member Function Documentation

virtual void NSEvaluation::PluginItem::process

(

NSCore::AcqisitionDataSet &

)

[inline, virtual]

process data

This function is used to process the data. This implementation does nothing, derived class have to to the real thing.

Reimplemented in NSEvaluation::AnalyzerItem, NSEvaluation::ModifierItem, and NSEvaluation::FilterItem.

Referenced by NSEvaluation::FilterItem::process(), and NSEvaluation::ModifierItem::process().

virtual QString NSEvaluation::PluginItem::type

(

)

const [pure virtual]

Implemented in NSEvaluation::AnalyzerItem, NSEvaluation::ModifierItem, and NSEvaluation::FilterItem.

Referenced by debug(), and guiString().

virtual QString NSEvaluation::PluginItem::name

(

)

const [pure virtual]

Implemented in NSEvaluation::AnalyzerItem, NSEvaluation::ModifierItem, and NSEvaluation::FilterItem.

Referenced by debug(), and guiString().

virtual QString NSEvaluation::PluginItem::help

(

)

const [inline, virtual]

Reimplemented in NSEvaluation::AnalyzerItem, NSEvaluation::ModifierItem, and NSEvaluation::FilterItem.

virtual NSCore::NamedParameterTreeItemPointer NSEvaluation::PluginItem::config

(

)

[pure virtual]

Give access to the configuration.

Implemented in NSEvaluation::AnalyzerItem, NSEvaluation::ModifierItem, and NSEvaluation::FilterItem.

QStringList NSEvaluation::PluginItem::guiActions

(

)

const [inline, virtual]

GUI: return the supported actions.

These actions will get symbols/buttons to get executed.

If you implement this, remember to call the parent guiActions() too:

 SomeTreeItem::guiActions() const {
   return QStringList() << <your actions> << BaseClass::guiActions();
 }

Reimplemented from NSCore::QTreeItem.

Reimplemented in NSEvaluation::AnalyzerItem.

void NSEvaluation::PluginItem::guiExecAction	(	QString	n,
		NSCore::GuiServer_Interface *	gui
	)			[inline, virtual]

GUI: execute the named action.

If you implemented guiActions() you will also want to implement this. If you can't handle the named action yourself, call guiExecAction() of the parent class.

Of course this can also be used as a filter if you want to restrict access to actions of the parent class.

The second parameter lets you interact with the user by some basic means.

Parameters:

	n	The action to execute
	gui	The gui to use for interactions

Reimplemented from NSCore::QTreeItem.

References NSCore::QTreeItem::guiExecAction(), sExecAdd(), and sExecRemove().

QString NSEvaluation::PluginItem::guiString

(

)

const [inline]

References name(), and type().

void NSEvaluation::PluginItem::sExecAdd	(	NSCore::QTreeItem *	,
		NSCore::GuiServer_Interface *
	)			[signal]

Referenced by guiExecAction().

void NSEvaluation::PluginItem::sExecRemove	(	NSCore::QTreeItem *	,
		NSCore::GuiServer_Interface *
	)			[signal]

Referenced by guiExecAction().

QString NSEvaluation::PluginItem::debug

(

)

const [inline, protected, virtual]

debug...

Implements NSCore::QTreeItem.

References name(), and type().

bool NSEvaluation::PluginItem::createFromXML

(

QDomNode

node

)

[protected, virtual]

Create childs from XML.

On fromXml() this gets called after successfull return from restoreFromXML(). If you want to create childs of this item from the childs of the QDomNode given, you can do so.

The return value defines whether fromXml will be called on the childs for the child-xml-items.

The default implementation returns true, so the child items get a chance to restore their state too.

Parameters:

node

The QDomNode to restore from

Reimplemented from NSCore::QTreeItem.

---

The documentation for this class was generated from the following file:

• evaluationpath_items.h