NSEvaluation::Modifier Class Reference

The base-class for Modifiers. More...

#include <plugins_interface.h>

Inheritance diagram for NSEvaluation::Modifier:

NSEvaluation::Plugin
Collaboration diagram for NSEvaluation::Modifier:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 Modifier (NSCore::QTreeItem *p)
virtual void prepare (NSCore::AcqisitionDataSet &data)
 Hook for preparations.
virtual void modify (NSCore::AcqisitionDataSet &data, int oldgeneration)=0
 The modifier function This function is called to do the real modifications of the data. A new instance of data is created before this function gets called.

Public Attributes

QString prefix
 The prefix to add to the result-tree.
int samples
 Number of samples to create in the new generation.
int channels
 Number of channels to create in the new generation.


Detailed Description

The base-class for Modifiers.

Modifiers return a new dataset which is ( should be? ) derived from the given set.

See also:
modify

Constructor & Destructor Documentation

NSEvaluation::Modifier::Modifier ( NSCore::QTreeItem p  )  [inline]


Member Function Documentation

virtual void NSEvaluation::Modifier::prepare ( NSCore::AcqisitionDataSet data  )  [inline, virtual]

Hook for preparations.

Implement this function if you need to do some things before the real new generation is created.

For example you can analyze the data to check whether your prerequisites are fulfilled. And you you set/change channels and samples to the values you like. That way your new generation (if there is one to be created) will have the parameters you want.

References NSCore::AcqisitionDataSet::channels(), channels, prefix, NSCore::AcqisitionDataSet::samples(), samples, and NSEvaluation::Plugin::type().

Referenced by NSEvaluation::ModifierItem::process().

virtual void NSEvaluation::Modifier::modify ( NSCore::AcqisitionDataSet data,
int  oldgeneration 
) [pure virtual]

The modifier function This function is called to do the real modifications of the data. A new instance of data is created before this function gets called.

If you want to check whether a new generation was created, just compare oldgeneration with data.currentGenerationNumber().

Referenced by NSEvaluation::ModifierItem::process().


Member Data Documentation

The prefix to add to the result-tree.

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

Number of samples to create in the new generation.

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

Number of channels to create in the new generation.

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


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

Generated on Tue Apr 12 02:10:37 2011 for epos by  doxygen 1.5.5