MeVisLabToolboxReference
Public Member Functions | Protected Member Functions | Protected Attributes
ml::WEMModule Class Reference

The WEMModule class provides some common fields and methods for WEMProcessors, WEMGenerators and WEMInspectors. More...

#include <WEMModule.h>

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

List of all members.

Public Member Functions

 WEMModule (std::string type="WEMModule", int numInImages=0, int numOutImages=0)
 Standard constructor.
std::string getType ()
 Returns the type of the WEMGenerator.

Protected Member Functions

virtual ~WEMModule ()
 Standard destructor.
virtual void handleNotification (Field *field)
 Called when input changes.
virtual void activateAttachments ()
 Initialize module after loading.
void _startProcessing ()
 Start processing timer.
void _finishProcessing ()
 End processing timer.

Protected Attributes

BoolField * _isProcessingFld
 Is the module currently processing?
FloatField * _elapsedTimeFld
 Elapsed time.
std::string _type
 The module type as a string.

Detailed Description

The WEMModule class provides some common fields and methods for WEMProcessors, WEMGenerators and WEMInspectors.

Definition at line 25 of file WEMModule.h.

Constructor & Destructor Documentation

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

Standard constructor.

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

Standard destructor.

Member Function Documentation

void ml::WEMModule::_finishProcessing ( ) [protected]

End processing timer.

void ml::WEMModule::_startProcessing ( ) [protected]

Start processing timer.

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

Initialize module after loading.

Reimplemented from ml::FieldContainer.

Reimplemented in ml::WEMGenerator, ml::WEMInspector, and ml::WEMProcessor.

std::string ml::WEMModule::getType ( ) [inline]

Returns the type of the WEMGenerator.

Definition at line 37 of file WEMModule.h.

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

Called when input changes.

Reimplemented from ml::Module.

Reimplemented in ml::WEMGenerator, ml::WEMInspector, and ml::WEMProcessor.

Member Data Documentation

FloatField* ml::WEMModule::_elapsedTimeFld [protected]

Elapsed time.

Definition at line 51 of file WEMModule.h.

BoolField* ml::WEMModule::_isProcessingFld [protected]

Is the module currently processing?

Definition at line 49 of file WEMModule.h.

std::string ml::WEMModule::_type [protected]

The module type as a string.

This is set in the according module's constructor.

Definition at line 58 of file WEMModule.h.

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