MeVisLabToolboxReference
ml::BackgroundTaskBaseModule Class Reference

Base class for ML modules that use background tasks. More...

#include <mlBackgroundTaskBaseModule.h>

Inheritance diagram for ml::BackgroundTaskBaseModule:
ml::Module ml::BackgroundTaskModuleHandler ml::FieldContainer ml::Base ml::RTObjectSave

Public Member Functions

 BackgroundTaskBaseModule (int n=1, int m=0)
 Constructor. More...
 
void handleNotification (Field *field) override
 Handle field changes of the field field. More...
 
- Public Member Functions inherited from ml::Module
MLMetaProfilePtrgetMetaProfile () const
 Returns the meta profile for the base operator. More...
 
const char * getTypeNameFast () const
 Macro to declare methods for the ML runtime type system (see mlRuntimeSubClass.h). More...
 
 Module (int numInputImages, int numOutputImages)
 Constructor: Initializes numInputImages input images and numOutputImages output images of the module. More...
 
 ~Module () override
 Destructor: Destroys this module. More...
 
std::string whoAmI (bool withInstanceName=true) const
 Returns type and instance name of format "ModuleTypeName(ModuleInstanceName)" if the instance name is not empty and withInstanceName is true. More...
 
InputConnectorFieldgetInputImageField (MLint i) const
 Returns the field representing input image i. i must be a valid index. More...
 
OutputConnectorFieldgetOutputImageField (MLint i=0) const
 Returns field representing output image i. i must be a valid index. More...
 
MLint getNumInputImages () const
 Returns number of input images of this module. More...
 
MLint getNumOutputImages () const
 Returns number of output images of this module. More...
 
PagedImagegetOutputImage (MLint outputIndex=0) const
 Returns output image outputIndex. The index needs to be in the range [0, getNumOutputImages()-1]. More...
 
InputConnectorFieldaddInputImage (const char *name=nullptr)
 Adds a new input image with name to the module. More...
 
OutputConnectorFieldaddOutputImage (const char *name=nullptr)
 Adds a new output image with name to the module. More...
 
PagedImagegetInputImage (MLint inputIndex, bool getReal=false) const
 Returns the output image of the module connected to input inputIndex. More...
 
PagedImagegetUpdatedInputImage (MLint inputIndex, bool getReal=false) const
 Convenience method for safe access to the input image at index inputIndex. More...
 
MLErrorCode processAllPages (int outputIndex=-1, SubImageBox region=SubImageBox(), MLRequestProgressCB *progressCallback=nullptr, void *progressCallbackUserData=nullptr) ML_RETURN_VALUE_SHOULD_BE_USED
 Processes all pages of a module for easy implementation of page-based image processing of complete images. More...
 
MLErrorCode processAllPages (ProcessAllPagesHandler &handler, SubImageBox region=SubImageBox(), MLRequestProgressCB *progressCallback=nullptr, void *progressCallbackUserData=nullptr) ML_RETURN_VALUE_SHOULD_BE_USED
 Process input images with a ProcessAllPagesHandler handler on a temporary output image (which allocates no data) For details, see processAllPages(-1) above. More...
 
MLErrorCode processMissingPages (int outputIndex=0, SubImageBox region=SubImageBox(), MLRequestProgressCB *progressCallback=nullptr, void *progressCallbackUserData=nullptr) ML_RETURN_VALUE_SHOULD_BE_USED
 Processes all missing pages on the given output image. More...
 
void clearOutputImage (MLint i=0)
 Clear cached output image pages of output image i. More...
 
InputConnectorFieldaddInputConnector (const char *name, Module *module, MLint i) override
 
OutputConnectorFieldaddOutputConnector (const char *name, Module *module, MLint i) override
 
MLint getOutputImageInplace (MLint outputIndex=0) const
 Return optimization flag: Return index of input image whose input tile is used also as output page for output outputIndex in calculateOutputSubImage() (instead of allocating its own memory). More...
 
MLint getBypass (MLint outputIndex=0) const
 Returns the currently bypass index or -1 if bypassing is disabled (default). More...
 
THREAD_SUPPORT getThreadSupport () const
 Returns the multithreading mode supported by this module, default is NO_THREAD_SUPPORT. More...
 
bool areRecursiveHandleNotificationsPermitted () const
 Returns if recursive entries in handleNotification are permitted. More...
 
MLint getHandleNotificationEntryCounter () const
 A counter returning the current number of (recursive re)entries in handleNotification. More...
 
PERMITTED_TYPES getVoxelDataTypeSupport () const
 Returns the current state of supported voxel data types. More...
 
bool isSupportedVoxelDataType (MLDataType dt) const
 Check if a given data type is supported on the module as configured with setVoxelDataTypeSupport. More...
 
virtual INPUT_HANDLE handleInput (int, INPUT_STATE) const
 This method may be reimplemented to enable support for invalid input images on the module. More...
 
INPUT_STATE getInputState (MLint index)
 Returns the current state of the input connection. More...
 
INPUT_STATE getUpdatedInputState (MLint index)
 Returns the updated state of the input image by calling updateImageProperties(index) and returning getInputState(index) afterwards. More...
 
bool isInputImageField (Field *field) const
 Returns if the given field is an input image field. This can be used in handleNotification(), to check if one of the input images has changed. More...
 
void touchOutputImageFields () const
 Touch all output image fields to indicate that the images have changed. More...
 
FieldContainergetFieldContainer ()
 Returns a pointer to the container of all the module's fields. More...
 
const FieldContainergetFieldContainer () const
 Returns a constant pointer to the container of all the module's fields. More...
 
virtual void beginSaveFields ()
 Called before all fields data contents of this modules are saved. More...
 
virtual void endSaveFields ()
 Called after saving all field contents of this module. More...
 
bool getMemoryOutputControl (MLint outputIndex) const
 
BaseOpgetInOp (MLint i, bool getReal=false) const
 
MLint getInOpIndex (MLint i, bool getReal=false) const
 
MLint getOutImgInplace (MLint outIndex=0) const
 
MLint getInputNum () const
 
MLint getOutputNum () const
 
PagedImagegetOutImg (MLint i=0) const
 
PagedImagegetInImg (MLint i, bool getReal=false) const
 
PagedImagegetUpdatedInImg (MLint i, bool getReal=false)
 
PagedImagegetNonDummyUpdatedInImg (int inIndex)
 This convenience routine gets the input image from input at connector inputIndex with the getUpdatedInImg(inputIndex) method and returns NULL if the value is a NULL pointer or if the image pointer is identical with DummyOp::getGlobalOutImg(); otherwise the pointer to the valid PagedImage is returned. More...
 
void clearOutImg (MLint i=0)
 
InputConnectorFieldgetInField (MLint i) const
 
OutputConnectorFieldgetOutField (MLint i=0) const
 
const FieldContainergetConstFieldContainer () const
 
- Public Member Functions inherited from ml::FieldContainer
 FieldContainer ()
 Constructor. More...
 
 ~FieldContainer () override
 Destructor: Deletes all added fields. More...
 
FieldaddField (const char *name, const char *type, const char *value)
 Adds a new field with name name, type type and value value (coded as string) to the container. More...
 
FieldaddField (Field *field)
 Adds a field, the ownership of the field is passed to the FieldContainer. More...
 
BoolFieldaddBool (const char *name)
 Creates a BoolField with name and adds it to the container. Default value is false. More...
 
BoolFieldaddBool (const char *name, bool value)
 Creates a BoolField with name and adds it to the container. More...
 
IntFieldaddInt (const char *name)
 Creates an IntField with name and adds it to the container. Default value is 0. More...
 
IntFieldaddInt (const char *name, MLint value)
 Creates an IntField with name and adds it to the container. More...
 
EnumFieldaddEnum (const char *name, const char *const *enumerationItemNames, MLint numEnumerationItems)
 Creates an EnumField field with name and adds it to the container. More...
 
EnumFieldaddEnum (const char *name, const std::vector< std::string > &enumerationItemNames)
 Creates an EnumField field with name and adds it to the container. More...
 
template<typename EnumType >
TypedEnumField< EnumType > * addEnum (const char *name, const EnumValues< EnumType > &values, EnumType initialValue)
 Creates a TypedEnumField field with name and adds it to the container. More...
 
FloatFieldaddFloat (const char *name)
 Creates a FloatField with name and adds it to the container. Default value is 0.f. More...
 
FloatFieldaddFloat (const char *name, float value)
 Creates a FloatField with name and adds it to the container. More...
 
ProgressFieldaddProgress (const char *name)
 Creates a float ProgressField with name and adds it to the container. Default value is 0.f. More...
 
ProgressFieldaddProgress (const char *name, float value)
 Creates a float ProgressField with name and adds it to the container. More...
 
DoubleFieldaddDouble (const char *name)
 Creates a DoubleField with name and adds it to the container. Default value is 0. More...
 
DoubleFieldaddDouble (const char *name, double value)
 Creates a DoubleField with name and adds it to the container. More...
 
StringFieldaddString (const char *name)
 Creates a StringField with name and adds it to the container. Default value is empty string. More...
 
StringFieldaddString (const char *name, const std::string &value)
 Creates a StringField with name and adds it to the container. More...
 
NotifyFieldaddNotify (const char *name)
 Creates a NotifyField field with name and adds it to the container. More...
 
TriggerFieldaddTrigger (const char *name)
 Creates a TriggerField field with name and adds it to the container. More...
 
BaseFieldaddBase (const char *name)
 Creates a Base field with name and adds it to the container. Default value is NULL. More...
 
BaseFieldaddBase (const char *name, Base *value)
 Creates a Base field with name and adds it to the container. More...
 
BaseFieldaddBase (const char *name, const RefCountedBasePtr &value)
 Creates a Base field with name and adds it to the container. Sets the value from intrusive pointer. More...
 
template<typename T >
BaseFieldaddBaseWithAllowedType (const char *name, T *value=nullptr)
 As above, but also sets the allowed type of the field. More...
 
template<typename T >
BaseFieldaddBaseWithAllowedType (const char *name, const ::boost::intrusive_ptr< T > &value)
 As above, but also sets the allowed type of the field. More...
 
template<typename T >
TypedBaseField< T > * addTypedBase (const char *name)
 Creates a TypedBaseField with name and adds it to the container. Default value is NULL. More...
 
template<typename T >
TypedBaseField< T > * addTypedBase (const char *name, T *value)
 Creates a TypedBaseField with name and adds it to the container. More...
 
template<typename T >
TypedBaseField< T > * addTypedBase (const char *name, const ::boost::intrusive_ptr< T > &value)
 Creates a TypedBaseField with name and adds it to the container. Sets the value from intrusive pointer. More...
 
SoNodeFieldaddSoNode (const char *name)
 Creates a SoNodeField with name and adds it to the container. Default value is NULL. More...
 
SoNodeFieldaddSoNode (const char *name, SoNode *value)
 Creates a SoNodeField with name and adds it to the container. More...
 
PointerFieldaddPointer (const char *name)
 Creates a PointerField with name and adds it to the container. More...
 
Vector2FieldaddVector2 (const char *name)
 Creates a Vector2Field with name and adds it to the container. More...
 
Vector2FieldaddVector2 (const char *name, const Vector2 &value)
 Creates a Vector2Field with name and adds it to the container. More...
 
Vector2FieldaddVector2 (const char *name, double x, double y)
 Creates a Vector2Field with name and adds it to the container. More...
 
Vector3FieldaddVector3 (const char *name)
 Creates a Vector3Field with name and adds it to the container. More...
 
Vector3FieldaddVector3 (const char *name, const Vector3 &value)
 Creates a Vector3Field with name and adds it to the container. More...
 
Vector3FieldaddVector3 (const char *name, double x, double y, double z)
 Creates a Vector3Field with name and adds it to the container. More...
 
Vector4FieldaddVector4 (const char *name)
 Creates a Vector4Field with name and adds it to the container. More...
 
Vector4FieldaddVector4 (const char *name, const Vector4 &value)
 Creates a Vector4Field with name and adds it to the container. More...
 
Vector4FieldaddVector4 (const char *name, double x, double y, double z, double w)
 Creates a Vector4Field with name and adds it to the container. More...
 
Vector5FieldaddVector5 (const char *name)
 Creates a Vector5Field with name and adds it to the container. More...
 
Vector5FieldaddVector5 (const char *name, const Vector5 &value)
 Creates a Vector5Field with name and adds it to the container. More...
 
Vector6FieldaddVector6 (const char *name)
 Creates a Vector6Field with name and adds it to the container. More...
 
Vector6FieldaddVector6 (const char *name, const Vector6 &value)
 Creates a Vector6Field with name and adds it to the container. More...
 
Vector10FieldaddVector10 (const char *name)
 Creates a Vector10Field with name and adds it to the container. More...
 
Vector10FieldaddVector10 (const char *name, const Vector10 &value)
 Creates a Vector10Field with name and adds it to the container. More...
 
ImageVectorFieldaddImageVector (const char *name)
 Creates a ImageVectorField with name and adds it to the container. More...
 
ImageVectorFieldaddImageVector (const char *name, const ImageVector &value)
 Creates a ImageVectorField with name and adds it to the container. More...
 
ImageVectorFieldaddImageVector (const char *name, MLint x, MLint y, MLint z, MLint c, MLint t, MLint u)
 Creates a ImageVectorField with name and adds it to the container. More...
 
SubImageBoxFieldaddSubImageBox (const char *name)
 Creates a SubImageBoxField with name and adds it to the container. More...
 
SubImageBoxFieldaddSubImageBox (const char *name, const SubImageBox &value)
 Creates a SubImageBoxField with name and adds it to the container. More...
 
SubImageBoxdFieldaddSubImageBoxd (const char *name)
 Creates a SubImageBoxd field with name and adds it to the container. More...
 
SubImageBoxdFieldaddSubImageBoxd (const char *name, const SubImageBoxd &value)
 Creates a SubImageBoxd field with name and adds it to the container. More...
 
ColorFieldaddColor (const char *name)
 Creates a ColorField with name and adds it to the container. More...
 
ColorFieldaddColor (const char *name, float r, float g, float b)
 Creates a ColorField with name and adds it to the container. More...
 
ColorFieldaddColor (const char *name, const Vector3 &value)
 Creates a ColorField with name and adds it to the container. More...
 
PlaneFieldaddPlane (const char *name)
 Creates a PlaneField with name and adds it to the container. More...
 
PlaneFieldaddPlane (const char *name, double f0, double f1, double f2, double f3)
 Creates a PlaneField with name and adds it to the container. More...
 
PlaneFieldaddPlane (const char *name, const Plane &value)
 Creates a PlaneField with name and adds it to the container. More...
 
RotationFieldaddRotation (const char *name)
 Creates a RotationField with name and adds it to the container. More...
 
RotationFieldaddRotation (const char *name, const Rotation &value)
 Creates a RotationField with name and adds it to the container. More...
 
Matrix2FieldaddMatrix2 (const char *name)
 Creates a Matrix2Field with name and adds it to the container. More...
 
Matrix2FieldaddMatrix2 (const char *name, const Matrix2 &value)
 Creates a Matrix2Field with name and adds it to the container. More...
 
Matrix3FieldaddMatrix3 (const char *name)
 Creates a Matrix3Field with name and adds it to the container. More...
 
Matrix3FieldaddMatrix3 (const char *name, const Matrix3 &value)
 Creates a Matrix3Field with name and adds it to the container. More...
 
Matrix4FieldaddMatrix4 (const char *name)
 Creates a Matrix4Field with name and adds it to the container. More...
 
Matrix4FieldaddMatrix4 (const char *name, const Matrix4 &value)
 Creates a Matrix4Field with name and adds it to the container. More...
 
Matrix5FieldaddMatrix5 (const char *name)
 Creates a Matrix5Field with name and adds it to the container. More...
 
Matrix5FieldaddMatrix5 (const char *name, const Matrix5 &value)
 Creates a Matrix5Field with name and adds it to the container. More...
 
Matrix6FieldaddMatrix6 (const char *name)
 Creates a Matrix6Field with name and adds it to the container. More...
 
Matrix6FieldaddMatrix6 (const char *name, const Matrix6 &value)
 Creates a Matrix6Field with name and adds it to the container. More...
 
MatrixFieldaddMatrix (const char *name)
 Creates a MatrixField with name and adds it to the container. More...
 
MatrixFieldaddMatrix (const char *name, const Matrix4 &value)
 Creates a MatrixField with name and adds it to the container. More...
 
MLDataTypeFieldaddMLDataType (const char *name)
 Creates a MTDataTypeField with name and adds it to the container. More...
 
MLDataTypeFieldaddMLDataType (const char *name, MLDataType value)
 Creates a MTDataTypeField with name and adds it to the container. More...
 
UniversalTypeFieldaddUniversalType (const char *name)
 Creates an UniversalTypeField field with name and adds it to the container. More...
 
IntListFieldaddIntList (const char *name)
 Creates an IntListField field with name and empty list value and adds it to the container. More...
 
IntListFieldaddIntList (const char *name, const std::vector< MLint > &value)
 Creates an IntListField field with name and given list value and adds it to the container. More...
 
DoubleListFieldaddDoubleList (const char *name)
 Creates an DoubleListField field with name and empty list value and adds it to the container. More...
 
DoubleListFieldaddDoubleList (const char *name, const std::vector< double > &value)
 Creates an DoubleListField field with name and given list value and adds it to the container. More...
 
Vector2ListFieldaddVector2List (const char *name)
 Creates an Vector2ListField field with name and empty list value and adds it to the container. More...
 
Vector2ListFieldaddVector2List (const char *name, const std::vector< Vector2 > &value)
 Creates an Vector2ListField field with name and given list value and adds it to the container. More...
 
Vector3ListFieldaddVector3List (const char *name)
 Creates an Vector3ListField field with name and empty list value and adds it to the container. More...
 
Vector3ListFieldaddVector3List (const char *name, const std::vector< Vector3 > &value)
 Creates an Vector3ListField field with name and given list value and adds it to the container. More...
 
Vector4ListFieldaddVector4List (const char *name)
 Creates an Vector4ListField field with name and empty list value and adds it to the container. More...
 
Vector4ListFieldaddVector4List (const char *name, const std::vector< Vector4 > &value)
 Creates an Vector4ListField field with name and given list value and adds it to the container. More...
 
size_t getNumFields () const
 Returns the number of added fields. More...
 
bool hasField (const std::string &name) const
 Returns true if the field with name name exists; otherwise false is returned. More...
 
FieldgetField (const std::string &name) const
 Returns the pointer to the field with name name. More...
 
FieldgetField (MLint index) const
 Returns pointer of field at index if it exists. If not, -1 is returned. More...
 
MLint getFieldIndex (Field *field) const
 Returns index of field if it exists. If not, -1 is returned. More...
 
void setFieldStringValue (const std::string &name, const std::string &value)
 Sets the value of the field with name if it exists. More...
 
std::string getFieldStringValue (const std::string &name) const
 Returns the string value of the field with name if it is found. More...
 
virtual void activateAttachments ()
 Reactivates notification handling, i.e., all fields of this module will send notifications again to attached sensors and fields if their value is set or changed. More...
 
virtual void deactivateAttachments ()
 Disables notification handling, i.e., all fields of this module will not send notifications to attached sensors and fields any more if their values are set or changed. More...
 
InputConnectorFieldaddInputConnector (Module *module, MLint i)
 
OutputConnectorFieldaddOutputConnector (Module *module, MLint i)
 
LongDoubleFieldaddLongDouble (const char *name)
 
LongDoubleFieldaddLongDouble (const char *name, MLldouble value)
 
Vector2FieldaddVec2f (const char *name)
 
Vector2FieldaddDeprecatedVec2f (const char *name, Vector2 *var0)
 
Vector3FieldaddVec3f (const char *name)
 
Vector3FieldaddDeprecatedVec3f (const char *name, Vector3 *var0)
 
Vector4FieldaddVec4f (const char *name)
 
Vector4FieldaddDeprecatedVec4f (const char *name, Vector4 *var0)
 
Vector5FieldaddVec5f (const char *name)
 
Vector6FieldaddVec6f (const char *name)
 
Vector6FieldaddDeprecatedVec6f (const char *name, Vector6 *var0)
 
Vector10FieldaddVec10f (const char *name)
 
ImageVectorFieldaddVector (const char *name)
 
ImageVectorFieldaddDeprecatedVector (const char *name, ImageVector *var0)
 
SubImageBoxFieldaddSubImgBox (const char *name)
 
SubImageBoxFieldaddDeprecatedSubImgBox (const char *name, SubImageBox *var0)
 
SubImageBoxdFieldaddSubImgBoxf (const char *name)
 
SubImageBoxdFieldaddDeprecatedSubImgBoxf (const char *name, SubImageBoxd *var0)
 
Matrix2FieldaddMat2 (const char *name)
 
Matrix3FieldaddMat3 (const char *name)
 
Matrix4FieldaddMat4 (const char *name)
 
Matrix5FieldaddMat5 (const char *name)
 
Matrix6FieldaddMat6 (const char *name)
 
BoolFieldaddDeprecatedBool (const char *name, bool *var)
 
IntFieldaddDeprecatedInt (const char *name, MLint *var)
 
ToggleFieldaddDeprecatedToggle (const char *name)
 
ToggleFieldaddDeprecatedToggle (const char *name, int *var)
 
EnumFieldaddDeprecatedEnum (const char *name, const char *const *enumNames, MLint enumNum, int *var)
 
FloatFieldaddDeprecatedFloat (const char *name, float *var)
 
ProgressFieldaddDeprecatedProgress (const char *name, float *var)
 
DoubleFieldaddDeprecatedDouble (const char *name, double *var)
 
Vector2FieldaddDeprecatedVector2 (const char *name, Vector2 *var0)
 
Vector3FieldaddDeprecatedVector3 (const char *name, Vector3 *var0)
 
Vector4FieldaddDeprecatedVector4 (const char *name, Vector4 *var0)
 
Vector6FieldaddDeprecatedVector6 (const char *name, Vector6 *var0)
 
ImageVectorFieldaddDeprecatedImageVector (const char *name, ImageVector *var0)
 
SubImageBoxFieldaddDeprecatedSubImageBox (const char *name, SubImageBox *var0)
 
SubImageBoxdFieldaddDeprecatedSubImageBoxd (const char *name, SubImageBoxd *var0)
 
ColorFieldaddDeprecatedColor (const char *name, Vector3 *var0)
 
MatrixFieldaddDeprecatedMatrix (const char *name, Matrix4 *mat)
 
MLDataTypeFieldaddDeprecatedMLDataType (const char *name, MLDataType *dt)
 
- Public Member Functions inherited from ml::Base
 Base ()
 Constructor. More...
 
virtual ~Base ()
 Destructor. More...
 
virtual BasedeepCopy () const
 Creates a deep copy of the given object. More...
 
bool isOfAllowedType (const std::vector< const RuntimeType * > &types) const
 Check if this object's type is equal to or derived from one of the types given in the argument. More...
 
virtual bool isRefCountedBase () const
 Returns if the instance is derived from RefCountedBase. More...
 
virtual std::string detailString () const
 Return a string describing this object. More...
 
virtual bool implementsPersistence (PersistenceInterface) const
 Override this method to declare which persistence interfaces are implemented by your derived class. More...
 
virtual char * getPersistentState () const ML_RETURN_VALUE_SHOULD_BE_USED
 Returns a C string describing the object's internal state. More...
 
virtual void setPersistentState (const char *)
 Restores the object's internal state from a string that had been previously generated using getPersistentState(). More...
 
virtual void clearPersistentState (char *) const
 Disposes a string previously allocated by getPersistentState(). More...
 
virtual void addStateToTree (TreeNode *) const
 Attaches the object state as children of the given parent node. More...
 
virtual void readStateFromTree (TreeNode *)
 Reads the object state from the children of the given parent node. More...
 
virtual void writeTo (AbstractPersistenceOutputStream *) const
 Write the objects state to the data stream object. More...
 
virtual void readFrom (AbstractPersistenceInputStream *, int)
 Read the objects state from the data stream object. More...
 
 ML_PERSISTENCE_VERSION (0)
 Set addStateToTree version number that can be accessed via getAddStateVersion() More...
 
- Public Member Functions inherited from ml::BackgroundTaskModuleHandler
 BackgroundTaskModuleHandler ()
 
virtual ~BackgroundTaskModuleHandler ()
 
virtual void setupTaskFields (Module *module)
 
NotifyFieldgetStartTaskField ()
 
NotifyFieldgetStartTaskSynchronousField ()
 
NotifyFieldgetCancelTaskField ()
 
BoolFieldgetTaskVerboseLoggingField ()
 
BoolFieldgetTaskRunningField ()
 
NotifyFieldgetTaskFinishedField ()
 
NotifyFieldgetTaskCanceledField ()
 
FloatFieldgetTaskProgressField ()
 
StringFieldgetTaskStatusField ()
 
virtual void handleTaskFieldNotification (Field *field)
 Handle field changes of the field field. More...
 
virtual void taskFinished (BackgroundTask *task)
 Callback for finished/canceled tasks (to be derived, make sure to call parent method). More...
 
virtual void postTaskFinished ()
 Called after taskFinished() has been called and can be used to handle the restarting of a task. More...
 
virtual ModuleBackgroundTaskcreateTask ()=0
 Request a new task to be created, reimplement this method and make sure that you keep no reference to your task, because it will be handed to the BackgroundTaskManager the ownership of the pointer is passed to the caller. More...
 
virtual void updateFinishedTaskStatus (BackgroundTask *task)
 Updates the status and progress field of a finished task, is called by taskFinished and may be reimplemented. More...
 
void startTask ()
 Start a task with mode Asynchronous. More...
 
void startTask (const ExecutionMode mode)
 Start a task with user specifying the mode (Synchronous or Asynchronous). More...
 
void cancelTask ()
 Cancel a task if it is currently running. More...
 
bool hasRunningTask ()
 Returns if a task is currently running (and not yet canceled). More...
 
bool willRestartTask ()
 Returns if the task will be restarted after the previous task has been canceled. More...
 
void setRestartTask (bool flag)
 Set if the task should be restarted after the previous task finishes. More...
 
void setTaskRunningField (BoolField *taskRunningField)
 We don't allow to set fields that trigger or cancel a process because that could easily lead to double notifications when old code already handles those fields. More...
 
void setTaskFinishedField (NotifyField *taskFinishedField)
 
void setTaskCanceledField (NotifyField *taskCanceledField)
 
void setTaskProgressField (FloatField *progressField)
 
void setTaskStatusField (StringField *statusField)
 

Additional Inherited Members

- Public Types inherited from ml::Module
enum  PERMITTED_TYPES {
  ONLY_SCALAR_TYPES, ONLY_DEFAULT_TYPES, ALL_REGISTERED_TYPES, ONLY_STANDARD_TYPES = ONLY_SCALAR_TYPES,
  FULLY_OPERATIONAL = ONLY_DEFAULT_TYPES, MINIMUM_OPERATIONAL = ALL_REGISTERED_TYPES
}
 See documentation of setVoxelDataTypeSupport. More...
 
enum  INPUT_STATE {
  DISCONNECTED = 0, CONNECTED_BUT_INVALID = 1, CONNECTED_AND_VALID = 2, CONNECTED_BUT_NEEDS_UPDATE = 3,
  OPEN = DISCONNECTED, UNDEFINED_CLOSED = CONNECTED_BUT_INVALID
}
 See documentation of handleInput. More...
 
enum  INPUT_HANDLE { INVALIDATE = 0, ALLOW_INVALID_INPUT = 2, REDIRECT_TO_DUMMY_OP = 1 }
 See documentation of handleInput. More...
 
- Public Types inherited from ml::Base
enum  PersistenceInterface { PersistenceByString, PersistenceByTreeNode, PersistenceByStream }
 This enum describes the different persistence interfaces available. More...
 
- Public Types inherited from ml::BackgroundTaskModuleHandler
enum  ExecutionMode { Synchronous, Asynchronous }
 Execution mode of background tasks. More...
 
- Static Public Member Functions inherited from ml::Module
static MLErrorCode getTile (PagedImage *image, SubImageBox loc, MLDataType datatype, void **data, const ScaleShiftData &scaleShiftData=ScaleShiftData(), MLRequestProgressCB *progressCallback=nullptr, void *progressCallbackUserData=nullptr) ML_RETURN_VALUE_SHOULD_BE_USED
 For documentation see Host::getTile() function with same signature. More...
 
static MLErrorCode getTile (PagedImage *image, SubImage &subimg, const ScaleShiftData &scaleShiftData=ScaleShiftData(), MLRequestProgressCB *progressCallback=nullptr, void *progressCallbackUserData=nullptr) ML_RETURN_VALUE_SHOULD_BE_USED
 For documentation see Host::getTile() function with same signature and Module passed as reference. More...
 
static MLErrorCode updateImageProperties (PagedImage *image) ML_RETURN_VALUE_SHOULD_BE_USED
 For documentation see Host::updateImageProperties() function with same signature. More...
 
static void freeTile (void *data)
 For documentation see Host::freeTile(). More...
 
static void updateProgress (const char *info1, const char *info2)
 For documentation see Host::updateProgress(). More...
 
static bool shouldTerminate ()
 For documentation see Host::shouldTerminate(). More...
 
static FieldgetPressedNotifyField ()
 For documentation see Host::getPressedNotifyField(). More...
 
static void adaptPageExtent (ImageVector &pageExtent, MLDataType imageType, const ImageVector &newImgExtent, const ImageVector &oldImgExtent, const ImageVector &pageUnit=ImageVector(0), const ImageVector &minPageExtent=ImageVector(0), const ImageVector &maxPageExtent=ImageVector(0))
 Adapt page size. More...
 
static std::string getVoxelValueAsString (PagedImage *image, const ImageVector &position, MLErrorCode *errorCode=nullptr, const std::string &errorResult="")
 Returns the voxel value at position position of the image image. More...
 
static size_t getNumModules ()
 Returns number of instantiated modules. More...
 
static ModulegetModule (size_t index)
 Returns pointer to instantiated module index. More...
 
static MLint findModuleIndex (Module &module)
 Returns index of Module module. If not found -1 is returned. More...
 
static void destroyModule ()
 Destroys static allocated tables to avoid memory leaks. More...
 
static std::string getVoxelValueAsString (Module &op, MLint outIdx, const ImageVector &pos, MLErrorCode *errCode=nullptr, const std::string &errResult="")
 
static MLErrorCode getTile (Module *op, MLint outIndex, SubImageBox loc, MLDataType datatype, void **data, const ScaleShiftData &scaleShiftData=ScaleShiftData()) ML_RETURN_VALUE_SHOULD_BE_USED
 
static MLErrorCode getTile (Module *op, MLint outIndex, SubImage &subimg, const ScaleShiftData &scaleShiftData=ScaleShiftData()) ML_RETURN_VALUE_SHOULD_BE_USED
 
static MLErrorCode updateImageProps (Module *op, MLint outIndex) ML_RETURN_VALUE_SHOULD_BE_USED
 
static MLErrorCode updateImageProperties (Module *op, MLint outIndex) ML_RETURN_VALUE_SHOULD_BE_USED
 
static void getInInfos (const BaseOp &op, MLint i, bool getReal, bool *isValidInputRet, BaseOp **inOpRet, PagedImage **inImgRet, MLint *inOpIndexRet)
 
static void adaptPageExt (ImageVector &pageExt, MLDataType imgType, const ImageVector &newImgExt, const ImageVector &oldImgExt, const ImageVector &pageUnit=ImageVector(0), const ImageVector &minPageExt=ImageVector(0), const ImageVector &maxPageExt=ImageVector(0))
 
static size_t getNumBaseOps ()
 
static BaseOpgetBaseOp (size_t idx)
 
static MLint findBaseOpIndex (Module &op)
 
static void destroyBaseOp ()
 
- Protected Types inherited from ml::Module
enum  THREAD_SUPPORT {
  NO_THREAD_SUPPORT = PagedImage::NO_THREAD_SUPPORT, MULTITHREADED = PagedImage::MULTITHREADED, IO_THREAD = PagedImage::IO_THREAD, ML_CALCULATEOUTPUTSUBIMAGE_ON_STD_TYPES = PagedImage::MULTITHREADED,
  ML_CALCULATEOUTPUTSUBIMAGE_ON_ALL_TYPES = PagedImage::MULTITHREADED, CALC_OUTSUBIMAGE_ON_STD_TYPES = PagedImage::MULTITHREADED, CALC_OUTSUBIMAGE_ON_ALL_TYPES = PagedImage::MULTITHREADED
}
 Enumerator deciding whether and which type of multithreading is supported by this module. More...
 
- Protected Member Functions inherited from ml::Module
void handleNotificationInternal (Field *field, FieldSensor::Strength strength) override
 Called from FieldContainer whenever a field changes. More...
 
virtual CalculateOutputImageHandlercreateCalculateOutputImageHandler (PagedImage *outputImage)
 Creates the CalculateOutputImageHandler for the given output image outputImage. More...
 
virtual void calculateOutputImageProperties (int outputIndex, PagedImage *)
 Set properties of output image outputImage with output index outputIndex. More...
 
virtual void calculateOutputImageProperties (int)
 
virtual SubImageBox calculateInputSubImageBox (int, const SubImageBox &outputSubImageBox, int)
 Called by the Host to determine which input image region (tile) of input inputIndex is required to calculate a certain output image region (page) of output outputIndex. More...
 
virtual void calculateOutputSubImage (SubImage *outputSubImage, int outputIndex, SubImage *inputSubImages)
 Calculate page outputSubImage of output image with index outputIndex given the input image tiles in array inputSubImages. More...
 
virtual void provideCustomPage (int, const SubImageBox &, MLMemoryBlockHandle &)
 This method allows a Module to provide its own pages to the Host for the outputIndex output image. More...
 
void handleNotificationOff ()
 Decreases lock counter for handleNotification calls. More...
 
void handleNotificationOn ()
 Increases lock counter for handleNotification calls. More...
 
bool isHandleNotificationOn ()
 Returns true if handleNotification calls are permitted, otherwise false. More...
 
void setOutputImageInplace (MLint outputIndex=0, MLint inputIndex=0)
 Set optimization flag: If calculating a page in calculateOutputSubImage(), the output image page of output outputIndex shall use the same memory as the input page of input inputIndex. More...
 
void unsetOutputImageInplace (MLint outputIndex=0)
 Clear optimization flag: output page of output at outputIndex and input tile shall use different memory buffers in calculateOutputSubImage(). More...
 
void setBypass (MLint outputIndex=0, MLint inputIndex=0)
 Sets the input image whose pages can also be used instead of output pages for the output image at outputIndex to avoid recalculations. More...
 
void setClampPagesToImageExtent (bool flag=true)
 Enables/disables page clamping on all output images. More...
 
void setThreadSupport (THREAD_SUPPORT supportMode)
 Pass any THREAD_SUPPORT supportMode to decide whether and what type of multithreading is supported by this module. More...
 
void permitRecursiveHandleNotifications (bool enable)
 If this flag is set to enable =true, recursive entries in handleNotification are permitted. More...
 
void setVoxelDataTypeSupport (PERMITTED_TYPES permTypes)
 Specifies which types this module supports. More...
 
void setMemoryOutputControl (MLint outputIndex, bool manually)
 
void setOutImgInplace (MLint outIndex=0, MLint inIndex=0)
 
void unsetOutImgInplace (MLint outIndex=0)
 
- Protected Attributes inherited from ml::BackgroundTaskModuleHandler
NotifyField_startTask
 
NotifyField_startTaskSynchronous
 
NotifyField_cancelTask
 
FloatField_progress
 
StringField_status
 
BoolField_taskRunning
 
NotifyField_taskFinished
 
NotifyField_taskCanceled
 
BoolField_taskVerboseLogging
 

Detailed Description

Base class for ML modules that use background tasks.

Definition at line 30 of file mlBackgroundTaskBaseModule.h.

Constructor & Destructor Documentation

ml::BackgroundTaskBaseModule::BackgroundTaskBaseModule ( int  n = 1,
int  m = 0 
)

Constructor.

Member Function Documentation

void ml::BackgroundTaskBaseModule::handleNotification ( Field field)
overridevirtual

Handle field changes of the field field.

Reimplemented from ml::Module.

Reimplemented in ml::RTObjectSave.


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