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

Base class for CSOModules. More...

#include <CSOBaseModule.h>

Inheritance diagram for ml::CSOBaseModule:
ml::Module ml::FieldContainer ml::Base ml::CSOConvertor ml::CSOGenerator ml::CSOModificator ml::CSOProcessor ml::CSOBulgeProcessor ml::CSOFreehandProcessor ml::CSOIsoProcessor ml::CSOLiveWireProcessor ml::CSOModifyProcessor ml::CSOPrimitiveProcessor ml::CSOTransformationProcessor

List of all members.

Public Member Functions

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

Protected Member Functions

virtual ~CSOBaseModule ()
 Standard destructor.
virtual void activateAttachments ()
 Initialize module after loading.
virtual void handleNotification (Field *field)
 Called when input changes.
void _setIsProcessingFlag (bool newProcessingState)
 Sets the isProcessing field if the processing state has changed.
 ML_MODULE_CLASS_HEADER (CSOBaseModule)

Protected Attributes

EnumField * _updateModeFld
 Enumeration field for update modes.
BoolField * _autoApplyFld
 Shall changes lead to an apply?
NotifyField * _applyFld
 Applies changes.
BoolField * _isProcessingFld
 Field reflects whether the module is currently processing.
NotifyField * _doneFld
 Notifies the application or other modules that the processing has ended.
std::string _type
 The processor type as a string.

Detailed Description

Base class for CSOModules.

Definition at line 25 of file CSOBaseModule.h.

Constructor & Destructor Documentation

ml::CSOBaseModule::CSOBaseModule ( const std::string &  type = "CSOBaseModule",
int  numInImages = 0,
int  numOutImages = 0 
)

Standard constructor.

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

Standard destructor.

Member Function Documentation

void ml::CSOBaseModule::_setIsProcessingFlag ( bool  newProcessingState) [protected]

Sets the isProcessing field if the processing state has changed.

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

Initialize module after loading.

Reimplemented from ml::FieldContainer.

Reimplemented in ml::CSOConvertor, ml::CSOModificator, ml::CSOBulgeProcessor, ml::CSOFreehandProcessor, ml::CSOIsoProcessor, ml::CSOLiveWireProcessor, and ml::CSOModifyProcessor.

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

Called when input changes.

Reimplemented from ml::Module.

Reimplemented in ml::CSOConvertor, ml::CSOModificator, ml::CSOBulgeProcessor, ml::CSOFreehandProcessor, ml::CSOIsoProcessor, ml::CSOLiveWireProcessor, ml::CSOModifyProcessor, and ml::CSOTransformationProcessor.

ml::CSOBaseModule::ML_MODULE_CLASS_HEADER ( CSOBaseModule  ) [protected]

Member Data Documentation

NotifyField* ml::CSOBaseModule::_applyFld [protected]

Applies changes.

Definition at line 53 of file CSOBaseModule.h.

BoolField* ml::CSOBaseModule::_autoApplyFld [protected]

Shall changes lead to an apply?

Definition at line 51 of file CSOBaseModule.h.

NotifyField* ml::CSOBaseModule::_doneFld [protected]

Notifies the application or other modules that the processing has ended.

Definition at line 58 of file CSOBaseModule.h.

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

Field reflects whether the module is currently processing.

Definition at line 56 of file CSOBaseModule.h.

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

The processor type as a string.

This is set in the according processor's constructor.

Definition at line 65 of file CSOBaseModule.h.

Referenced by ml::CSOGenerator::getType().

EnumField* ml::CSOBaseModule::_updateModeFld [protected]

Enumeration field for update modes.

Definition at line 49 of file CSOBaseModule.h.

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