ML Reference
ml::DummyOp Class Reference

Dummy input operator with one pixel of value 0 in it. More...

#include <mlDummyOp.h>

Inheritance diagram for ml::DummyOp:
ml::BaseOp ml::Module ml::FieldContainer ml::Base

List of all members.

Public Member Functions

 DummyOp ()
 Constructs operator with 0 inputs and 1 output with no parameters.

Static Public Member Functions

static DummyOpgetGlobalInstance ()
 A global instance of a dummy module which is connected to open or undefined input module inputs sometimes.
static PagedImage & getGlobalOutImg ()
 Return the output image of getGlobalInstance().
static void destroyDummyOp ()
 Destroy static allocated data to avoid memory leaks.

Detailed Description

Dummy input operator with one pixel of value 0 in it.

It maintains a global instance of such an image.

Its output image has size = (1,1,1,1,1,1) page size = (64,64,1,1,1,1), data type = MLuint8, Min = 0, Max = 1, VoxelSize =(1,1,1) C, T and U dimension infos are all empty.

DummyOp::getGlobalInstance() and its image are heavily used when open inputs and closed but undefined inputs are enabled by overloading BaseOp::handleInput.

Deprecated:
Do not use it anymore, use Module::ALLOW_INVALID_INPUT in Module::handleInput instead!

Definition at line 52 of file mlDummyOp.h.


Constructor & Destructor Documentation

ml::DummyOp::DummyOp ( )

Constructs operator with 0 inputs and 1 output with no parameters.


Member Function Documentation

static void ml::DummyOp::destroyDummyOp ( ) [static]

Destroy static allocated data to avoid memory leaks.

To be called on ML destruction.

static DummyOp& ml::DummyOp::getGlobalInstance ( ) [static]

A global instance of a dummy module which is connected to open or undefined input module inputs sometimes.

Note that the pixel content is constantly 0 and must not be modified.

static PagedImage& ml::DummyOp::getGlobalOutImg ( ) [static]

Return the output image of getGlobalInstance().


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