MeVisLabToolboxReference
ml::WEMGenerator Class Reference

The WEMGenerator is the base class for all modules that generate WEMs, be it automatically or interactive. More...

#include <WEMGenerator.h>

Inheritance diagram for ml::WEMGenerator:
ml::WEMModule ml::Module ml::FieldContainer ml::Base ml::WEMProcessor

List of all members.

Public Member Functions

 WEMGenerator (std::string type="WEMGenerator", int numInImages=0, int numOutImages=0)
 Standard constructor.

Protected Member Functions

virtual ~WEMGenerator ()
 Standard destructor.
virtual void handleNotification (Field *field)
 Called when input changes.
virtual void activateAttachments ()
 Initialize module after loading.
virtual void _process ()
 Triggers the computation of the generation.
virtual void _finish (WEMPatch *wemPatch)
 Finish generation of given WEMPatch.
virtual void _addWEMPatch (WEMPatch *wemPatch)
 Adds a new WEMPatch to the output list and applies the default attributes.
void _applyFields (WEMPatch *wemPatch)
 Applies the default parameters to the given WEMPatch.
void _applyMetaFields (WEMPatch *wemPatch)
 Applies meta information parameters to the given WEMPatch.
virtual void _notifyObservers ()
 Notify observers with FINISHED | SELECTION | REPAINT message.
void _cleanup ()
 Removes previously generated WEMs.

Protected Attributes

BoolField_autoApplyFld
 Auto apply field.
BoolField_autoUpdateFld
 Auto update field.
BoolField_autoClearFld
 Auto clear field.
BoolField_overwriteLabelDescriptionFld
 Shall the label and the description be overwritten?
StringField_labelFld
 Field for changing the 'label' attribute of a WEM.
StringField_descriptionFld
 Field for changing the 'description' attribute of a WEM.
bool _outputWEMOwner
 Is this module the owner of the outputList?
WEMPtr _outWEM
 A pointer to the output WEM.

Detailed Description

The WEMGenerator is the base class for all modules that generate WEMs, be it automatically or interactive.

Basically it determines the type of the WEM and an id that can be used to associate WEMs with their generator.

Definition at line 29 of file WEMGenerator.h.


Constructor & Destructor Documentation

ml::WEMGenerator::WEMGenerator ( std::string  type = "WEMGenerator",
int  numInImages = 0,
int  numOutImages = 0 
)

Standard constructor.

virtual ml::WEMGenerator::~WEMGenerator ( ) [protected, virtual]

Standard destructor.


Member Function Documentation

virtual void ml::WEMGenerator::_addWEMPatch ( WEMPatch wemPatch) [protected, virtual]

Adds a new WEMPatch to the output list and applies the default attributes.

Reimplemented in ml::WEMProcessor.

void ml::WEMGenerator::_applyFields ( WEMPatch wemPatch) [protected]

Applies the default parameters to the given WEMPatch.

void ml::WEMGenerator::_applyMetaFields ( WEMPatch wemPatch) [protected]

Applies meta information parameters to the given WEMPatch.

void ml::WEMGenerator::_cleanup ( ) [protected]

Removes previously generated WEMs.

virtual void ml::WEMGenerator::_finish ( WEMPatch wemPatch) [protected, virtual]

Finish generation of given WEMPatch.

virtual void ml::WEMGenerator::_notifyObservers ( ) [protected, virtual]

Notify observers with FINISHED | SELECTION | REPAINT message.

Reimplemented in ml::WEMProcessor.

virtual void ml::WEMGenerator::_process ( ) [protected, virtual]

Triggers the computation of the generation.

Reimplemented in ml::WEMProcessor.

virtual void ml::WEMGenerator::activateAttachments ( ) [protected, virtual]

Initialize module after loading.

Reimplemented from ml::WEMModule.

Reimplemented in ml::WEMProcessor.

virtual void ml::WEMGenerator::handleNotification ( Field field) [protected, virtual]

Called when input changes.

Reimplemented from ml::WEMModule.

Reimplemented in ml::WEMProcessor.


Member Data Documentation

Auto apply field.

If this is enabled, generating is done whenever any field changes.

Definition at line 47 of file WEMGenerator.h.

Auto clear field.

If this is enabled, the output is invalidated whenever the input gets disconnected.

Definition at line 53 of file WEMGenerator.h.

Auto update field.

If this is enabled, generating is done whenever the input changes.

Definition at line 50 of file WEMGenerator.h.

Field for changing the 'description' attribute of a WEM.

Definition at line 60 of file WEMGenerator.h.

Field for changing the 'label' attribute of a WEM.

Definition at line 58 of file WEMGenerator.h.

Is this module the owner of the outputList?

Definition at line 66 of file WEMGenerator.h.

WEMPtr ml::WEMGenerator::_outWEM [protected]

A pointer to the output WEM.

Definition at line 68 of file WEMGenerator.h.

Shall the label and the description be overwritten?

Definition at line 56 of file WEMGenerator.h.


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