ML Reference
ml::TypedProcessAllPagesHandler< Derived, NumberOfInputImages, VariableType0, VariableType1, VariableType2, VariableType3 > Class Template Reference

TypedProcessAllPagesHandler can be used as a base class for a custom ProcessAllPages handler and supports up to four type variable types. More...

#include <mlTypedHandlers.h>

Inheritance diagram for ml::TypedProcessAllPagesHandler< Derived, NumberOfInputImages, VariableType0, VariableType1, VariableType2, VariableType3 >:
ml::internal::TypedHandlerBase< ProcessAllPagesHandler, Derived, NumberOfInputImages > ml::ProcessAllPagesHandler ml::CalculateOutputImageHandler

Additional Inherited Members

- Public Types inherited from ml::internal::TypedHandlerBase< ProcessAllPagesHandler, Derived, NumberOfInputImages >
enum  
 
- Public Member Functions inherited from ml::internal::TypedHandlerBase< ProcessAllPagesHandler, Derived, NumberOfInputImages >
 TypedHandlerBase ()
 
void calculateOutputSubImage (SubImage *outImg, SubImage *inImgs, UserThreadData *userThreadData) override
 Overrides the calculateOutputSubImage of CalculateOutputImageHandler. More...
 
- Public Member Functions inherited from ml::ProcessAllPagesHandler
virtual void calculateOutputImageProperties (PagedImage *)
 Calculates the (temporary and virtual) output image's properties, which by default has the properties of input image 0. More...
 
virtual bool wantsProgressUpdates ()
 Returns whether the handler wants to receive progress updates via updateProgress(). More...
 
virtual void updateProgress (double)
 Called in regular intervals if wantsProgressUpdates() == true. More...
 
void install (PagedImage *outImg)
 Installs the handler on the PagedImage, which is typically called by the ML Host; do not call it yourself! More...
 
virtual const char * getName ()
 Returns the name of the handler. More...
 
- Public Member Functions inherited from ml::CalculateOutputImageHandler
virtual ~CalculateOutputImageHandler ()
 Destructor. More...
 
virtual SubImageBox calculateInputSubImageBox (int, const SubImageBox &outputSubImageBox)
 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 image. More...
 
virtual UserThreadDatacreateUserThreadData ()
 Creates the thread local user data for a thread. More...
 
- Static Public Member Functions inherited from ml::internal::TypedHandlerBase< ProcessAllPagesHandler, Derived, NumberOfInputImages >
static void setupKnownProperties (PagedImage *outImg)
 Sets up the properties of the outImg and its input subimages according to the settings of OutputSubImage_Type, InputSubImage[0-9]_Type, ... More...
 
static bool verifyProperties (PagedImage *outImg)
 Verifies the properties of outImg (its data type and the datatypes of the input subimages, comparing them with the static properties of the variable types and fixed datatypes). More...
 

Detailed Description

template<typename Derived, int NumberOfInputImages, template< typename, int, typename >class VariableType0 = internal::NoTypes, template< typename, int, typename >class VariableType1 = internal::NoTypes, template< typename, int, typename >class VariableType2 = internal::NoTypes, template< typename, int, typename >class VariableType3 = internal::NoTypes>
class ml::TypedProcessAllPagesHandler< Derived, NumberOfInputImages, VariableType0, VariableType1, VariableType2, VariableType3 >

TypedProcessAllPagesHandler can be used as a base class for a custom ProcessAllPages handler and supports up to four type variable types.

Have a look at TypedCalculateOutputImageHandler for more details.

Definition at line 726 of file mlTypedHandlers.h.


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