Base class for all modules that wish to use and communicate (send and receive notifications) with the ObjMgr module. More...

#include <ObjMgr/mlObjMgrClient.h>

Inheritance diagram for ml::ObjMgrClient:

Public Types
enum	EventReceiveMode { EVENTS_NONE = 0 , EVENTS_SELECTED , EVENTS_ALL , NUM_EVENT_RECEIVE_MODES }
	Macro for declaring methods for the runtime system. More...

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 }
	See documentation of handleInput. More...

enum	INPUT_HANDLE { INVALIDATE = 0 , ALLOW_INVALID_INPUT = 2 }
	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 Member Functions
	~ObjMgrClient () override
	Destructor. Removes this ObjMgrClient from the ObjMgr. More...

void	addAcceptedObjectID (const std::string &id)
	Add object ID to set of accepted objects (id can be a regular expression). More...

void	clearAcceptedObjectIDs ()
	Clear set of accepted objects. More...

void	addAcceptedInfoLayerName (const std::string &layerName)
	Add layer name to set of accepted layers (layerName can be a regular expression). More...

void	clearAcceptedInfoLayerNames ()
	Clear set of accepted layers. More...

void	setEventReceiveMode (EventReceiveMode mode)
	Modify current events receive mode settings. More...

EventReceiveMode	getEventReceiveMode ()
	Returns current events receive mode settings. More...

void	sendNotification ()
	Send notification to all other modules connected to the ObjMgr. More...

const omEventContainer &	getEventContainer () const
	Get container with object manager events,. More...

void	clearEventContainer ()
	Clear event container. More...

Public Member Functions inherited from ml::ObjMgrBase
	~ObjMgrBase () override
	Macro for declaring methods for the runtime system. More...

Public Member Functions inherited from ml::Module
MLMetaProfilePtr &	getMetaProfile () 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...

InputConnectorField *	getInputImageField (MLint i) const
	Returns the field representing input image `i`. `i` must be a valid index. More...

OutputConnectorField *	getOutputImageField (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...

PagedImage *	getOutputImage (MLint outputIndex=0) const
	Returns output image `outputIndex`. The index needs to be in the range [0, getNumOutputImages()-1]. More...

InputConnectorField *	addInputImage (const char *name=nullptr)
	Adds a new input image with `name` to the module. More...

OutputConnectorField *	addOutputImage (const char *name=nullptr)
	Adds a new output image with `name` to the module. More...

PagedImage *	getInputImage (MLint inputIndex, bool getReal=false) const
	Returns the output image of the module connected to input `inputIndex`. More...

PagedImage *	getUpdatedInputImage (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)
	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)
	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)
	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...

InputConnectorField *	addInputConnector (const char name, Module module, MLint i) override

OutputConnectorField *	addOutputConnector (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...

FieldContainer *	getFieldContainer ()
	Returns a pointer to the container of all the module's fields. More...

const FieldContainer *	getFieldContainer () 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...

Public Member Functions inherited from ml::FieldContainer
	FieldContainer ()
	Constructor. More...

	~FieldContainer () override
	Destructor: Deletes all added fields. More...

std::string	whoAmI (bool withInstanceName=true) const
	Returns type and instance name of format "ClassTypeName(instanceName)" if the instance name is not empty and `withInstanceName` is true. More...

Field *	addField (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...

Field *	addField (Field *field)
	Adds a `field`, the ownership of the field is passed to the FieldContainer. More...

BoolField *	addBool (const char *name)
	Creates a BoolField with `name` and adds it to the container. Default value is false. More...

BoolField *	addBool (const char *name, bool value)
	Creates a BoolField with `name` and adds it to the container. More...

IntField *	addInt (const char *name)
	Creates an IntField with `name` and adds it to the container. Default value is 0. More...

IntField *	addInt (const char *name, MLint value)
	Creates an IntField with `name` and adds it to the container. More...

EnumField *	addEnum (const char name, const char const *enumerationItemNames, MLint numEnumerationItems)
	Creates an EnumField field with `name` and adds it to the container. More...

EnumField *	addEnum (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...

FloatField *	addFloat (const char *name)
	Creates a FloatField with `name` and adds it to the container. Default value is 0.f. More...

FloatField *	addFloat (const char *name, float value)
	Creates a FloatField with `name` and adds it to the container. More...

ProgressField *	addProgress (const char *name)
	Creates a float ProgressField with `name` and adds it to the container. Default value is 0.f. More...

ProgressField *	addProgress (const char *name, float value)
	Creates a float ProgressField with `name` and adds it to the container. More...

DoubleField *	addDouble (const char *name)
	Creates a DoubleField with `name` and adds it to the container. Default value is 0. More...

DoubleField *	addDouble (const char *name, double value)
	Creates a DoubleField with `name` and adds it to the container. More...

StringField *	addString (const char *name)
	Creates a StringField with `name` and adds it to the container. Default value is empty string. More...

StringField *	addString (const char *name, const std::string &value)
	Creates a StringField with `name` and adds it to the container. More...

NotifyField *	addNotify (const char *name)
	Creates a NotifyField field with `name` and adds it to the container. More...

TriggerField *	addTrigger (const char *name)
	Creates a TriggerField field with `name` and adds it to the container. More...

BaseField *	addBase (const char *name)
	Creates a Base field with `name` and adds it to the container. Default value is NULL. More...

BaseField *	addBase (const char name, Base value)
	Creates a Base field with `name` and adds it to the container. More...

BaseField *	addBase (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 >
BaseField *	addBaseWithAllowedType (const char name, T value=nullptr)
	As above, but also sets the allowed type of the field. More...

template<typename T >
BaseField *	addBaseWithAllowedType (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...

SoNodeField *	addSoNode (const char *name)
	Creates a SoNodeField with `name` and adds it to the container. Default value is NULL. More...

SoNodeField *	addSoNode (const char name, SoNode value)
	Creates a SoNodeField with `name` and adds it to the container. More...

PointerField *	addPointer (const char *name)
	Creates a PointerField with `name` and adds it to the container. More...

Vector2Field *	addVector2 (const char *name)
	Creates a Vector2Field with `name` and adds it to the container. More...

Vector2Field *	addVector2 (const char *name, const Vector2 &value)
	Creates a Vector2Field with `name` and adds it to the container. More...

Vector2Field *	addVector2 (const char *name, double x, double y)
	Creates a Vector2Field with `name` and adds it to the container. More...

Vector3Field *	addVector3 (const char *name)
	Creates a Vector3Field with `name` and adds it to the container. More...

Vector3Field *	addVector3 (const char *name, const Vector3 &value)
	Creates a Vector3Field with `name` and adds it to the container. More...

Vector3Field *	addVector3 (const char *name, double x, double y, double z)
	Creates a Vector3Field with `name` and adds it to the container. More...

Vector4Field *	addVector4 (const char *name)
	Creates a Vector4Field with `name` and adds it to the container. More...

Vector4Field *	addVector4 (const char *name, const Vector4 &value)
	Creates a Vector4Field with `name` and adds it to the container. More...

Vector4Field *	addVector4 (const char *name, double x, double y, double z, double w)
	Creates a Vector4Field with `name` and adds it to the container. More...

Vector5Field *	addVector5 (const char *name)
	Creates a Vector5Field with `name` and adds it to the container. More...

Vector5Field *	addVector5 (const char *name, const Vector5 &value)
	Creates a Vector5Field with `name` and adds it to the container. More...

Vector6Field *	addVector6 (const char *name)
	Creates a Vector6Field with `name` and adds it to the container. More...

Vector6Field *	addVector6 (const char *name, const Vector6 &value)
	Creates a Vector6Field with `name` and adds it to the container. More...

Vector10Field *	addVector10 (const char *name)
	Creates a Vector10Field with `name` and adds it to the container. More...

Vector10Field *	addVector10 (const char *name, const Vector10 &value)
	Creates a Vector10Field with `name` and adds it to the container. More...

ImageVectorField *	addImageVector (const char *name)
	Creates a ImageVectorField with `name` and adds it to the container. More...

ImageVectorField *	addImageVector (const char *name, const ImageVector &value)
	Creates a ImageVectorField with `name` and adds it to the container. More...

ImageVectorField *	addImageVector (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...

SubImageBoxField *	addSubImageBox (const char *name)
	Creates a SubImageBoxField with `name` and adds it to the container. More...

SubImageBoxField *	addSubImageBox (const char *name, const SubImageBox &value)
	Creates a SubImageBoxField with `name` and adds it to the container. More...

SubImageBoxdField *	addSubImageBoxd (const char *name)
	Creates a SubImageBoxd field with `name` and adds it to the container. More...

SubImageBoxdField *	addSubImageBoxd (const char *name, const SubImageBoxd &value)
	Creates a SubImageBoxd field with `name` and adds it to the container. More...

ColorField *	addColor (const char *name)
	Creates a ColorField with `name` and adds it to the container. More...

ColorField *	addColor (const char *name, float r, float g, float b)
	Creates a ColorField with `name` and adds it to the container. More...

ColorField *	addColor (const char *name, const Vector3 &value)
	Creates a ColorField with `name` and adds it to the container. More...

PlaneField *	addPlane (const char *name)
	Creates a PlaneField with `name` and adds it to the container. More...

PlaneField *	addPlane (const char *name, double f0, double f1, double f2, double f3)
	Creates a PlaneField with `name` and adds it to the container. More...

PlaneField *	addPlane (const char *name, const Plane &value)
	Creates a PlaneField with `name` and adds it to the container. More...

RotationField *	addRotation (const char *name)
	Creates a RotationField with `name` and adds it to the container. More...

RotationField *	addRotation (const char *name, const Rotation &value)
	Creates a RotationField with `name` and adds it to the container. More...

Matrix2Field *	addMatrix2 (const char *name)
	Creates a Matrix2Field with `name` and adds it to the container. More...

Matrix2Field *	addMatrix2 (const char *name, const Matrix2 &value)
	Creates a Matrix2Field with `name` and adds it to the container. More...

Matrix3Field *	addMatrix3 (const char *name)
	Creates a Matrix3Field with `name` and adds it to the container. More...

Matrix3Field *	addMatrix3 (const char *name, const Matrix3 &value)
	Creates a Matrix3Field with `name` and adds it to the container. More...

Matrix4Field *	addMatrix4 (const char *name)
	Creates a Matrix4Field with `name` and adds it to the container. More...

Matrix4Field *	addMatrix4 (const char *name, const Matrix4 &value)
	Creates a Matrix4Field with `name` and adds it to the container. More...

Matrix5Field *	addMatrix5 (const char *name)
	Creates a Matrix5Field with `name` and adds it to the container. More...

Matrix5Field *	addMatrix5 (const char *name, const Matrix5 &value)
	Creates a Matrix5Field with `name` and adds it to the container. More...

Matrix6Field *	addMatrix6 (const char *name)
	Creates a Matrix6Field with `name` and adds it to the container. More...

Matrix6Field *	addMatrix6 (const char *name, const Matrix6 &value)
	Creates a Matrix6Field with `name` and adds it to the container. More...

MatrixField *	addMatrix (const char *name)
	Creates a MatrixField with `name` and adds it to the container. More...

MatrixField *	addMatrix (const char *name, const Matrix4 &value)
	Creates a MatrixField with `name` and adds it to the container. More...

MLDataTypeField *	addMLDataType (const char *name)
	Creates a MTDataTypeField with `name` and adds it to the container. More...

MLDataTypeField *	addMLDataType (const char *name, MLDataType value)
	Creates a MTDataTypeField with `name` and adds it to the container. More...

UniversalTypeField *	addUniversalType (const char *name)
	Creates an UniversalTypeField field with `name` and adds it to the container. More...

IntListField *	addIntList (const char *name)
	Creates an IntListField field with `name` and empty list value and adds it to the container. More...

IntListField *	addIntList (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...

DoubleListField *	addDoubleList (const char *name)
	Creates an DoubleListField field with `name` and empty list value and adds it to the container. More...

DoubleListField *	addDoubleList (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...

Vector2ListField *	addVector2List (const char *name)
	Creates an Vector2ListField field with `name` and empty list value and adds it to the container. More...

Vector2ListField *	addVector2List (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...

Vector3ListField *	addVector3List (const char *name)
	Creates an Vector3ListField field with `name` and empty list value and adds it to the container. More...

Vector3ListField *	addVector3List (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...

Vector4ListField *	addVector4List (const char *name)
	Creates an Vector4ListField field with `name` and empty list value and adds it to the container. More...

Vector4ListField *	addVector4List (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...

Field *	getField (const std::string &name) const
	Returns the pointer to the field with name `name`. More...

Field *	getField (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...

Public Member Functions inherited from ml::Base
	Base ()
	Constructor. More...

virtual	~Base ()
	Destructor. More...

virtual Base *	deepCopy () const
	Set addStateToTree version number that can be accessed via getAddStateVersion() 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 std::string	persistentState () const
	Returns a string describing the object's internal state. More...

virtual void	setPersistentState (const std::string &state)
	Restores the object's internal state from a string that had been previously generated using `persistentState()`. 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...

Public Attributes
IntField *	priorityFld
	Priority determines the order in which events are send to ObjMgrClient modules. Default is 10000;. More...

StringField *	debugCommentFld
	Value of this field is used in debug output to distinguish different instances. More...

Public Attributes inherited from ml::ObjMgrBase
BaseField *	objectsOutFld
	Access field to object container. More...

Static Public Attributes
static const char *	EventReceiveModeStrings [NUM_EVENT_RECEIVE_MODES]
	Define strings for all event receive modes. These can be used for enum fields. More...

Protected Member Functions
void	handleNotification (Field *field) override
	Called when a field in the field container is changed. More...

virtual void	handleObjMgrNotification ()
	This function is called when the connected ObjMgr sends out a notification. More...

virtual void	objContainerChanged ()
	This function is called when the objectContainer has been changed. More...

const omObjectContainer *	getConstObjContainer () const

omObjectContainer *	getObjContainer ()

omEventContainer &	getMutableEventContainer ()
	Get read/write access to event container. More...

void	registerWithSourceModule ()
	Add this module to the source module's container of connected modules. More...

void	cancelSourceModuleRegistration ()
	Remove this module from the source module's container of connected modules. More...

void	registerWithObjMgr ()
	Register this and all connected modules with ObjMgr. More...

void	cancelObjMgrRegistration ()
	Remove registration of this and all connected modules from ObjMgr. More...

std::string	getDebugComment () const override
	Return debug comment. More...

	ObjMgrClient (int inputNum, int outputNum, EventReceiveMode eventReceiveMode)
	Constructor. More...

Protected Member Functions inherited from ml::ObjMgrBase
	ObjMgrBase (int inputNum, int outputNum)
	Constructor. More...

void	notifySensorsAndConnectedClients (bool fireOutputSensors)
	Notify all directly connected modules. More...

void	configureNetwork ()
	(Re)initialize/configure client connections. More...

void	buildGraph (std::multimap< ObjMgrBase , ObjMgrBase > &graph)
	May be used to build a graph of the network originating from 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 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...

virtual CalculateOutputImageHandler *	createCalculateOutputImageHandler (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 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...

Protected Member Functions inherited from ml::Base
virtual char *	getPersistentState () const
	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...

Protected Attributes
ObjMgr *	_objMgr
	Pointer to ObjMgr object. More...

ObjMgrBase *	_sourceModule
	Pointer to module, to which this module is connected. More...

MLint32	_skipNotificationCount
	If the value is >= the notification recursion depth in the ObjMgr, the ObjMgrClient does not notify attached FieldListeners. More...

omEventContainer	_events
	Container of changes that have occurred. More...

EventReceiveMode	_eventReceiveMode
	Determines which events will be received. More...

std::set< std::string >	_acceptedObjects
	Accept only events regarding objects stored in this set. More...

std::set< std::string >	_acceptedInfoLayers
	Accept only events of layers that are stored in this set. More...

Protected Attributes inherited from ml::ObjMgrBase
omObjMgrConnection	_connection
	Current connection that originates from this module. More...

std::set< ObjMgrBase * >	_connectedModules
	Container of directly connected ObjMgrBase modules. More...

Friends
class	ObjMgr

class	ObjMgrBase

Additional Inherited Members
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)
	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)
	For documentation see Host::getTile() function with same signature and Module passed as reference. More...

static MLErrorCode	updateImageProperties (PagedImage *image)
	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 Field *	getPressedNotifyField ()
	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 Module *	getModule (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...

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 }
	Enumerator deciding whether and which type of multithreading is supported by this module. More...

Detailed Description

Base class for all modules that wish to use and communicate (send and receive notifications) with the ObjMgr module.

Definition at line 46 of file mlObjMgrClient.h.

Member Enumeration Documentation

◆ EventReceiveMode

enum ml::ObjMgrClient::EventReceiveMode

Macro for declaring methods for the runtime system.

Event receive modes

Enumerator
EVENTS_NONE
EVENTS_SELECTED
EVENTS_ALL
NUM_EVENT_RECEIVE_MODES

Definition at line 59 of file mlObjMgrClient.h.

Constructor & Destructor Documentation

◆ ObjMgrClient()

ml::ObjMgrClient::ObjMgrClient	(	int	inputNum,
		int	outputNum,
		EventReceiveMode	eventReceiveMode
	)

protected

Constructor.

Register this ObjMgrClient with the ObjMgr. If eventReceiveMode is EVENTS_ALL or EVENTS_SELECTED the ObjMgrClient will receive events, only a minor number of modules need this. Think about it carefully! Be sure to clear the event container from time to time if you choose to receive events!

◆ ~ObjMgrClient()

ml::ObjMgrClient::~ObjMgrClient ( )

override

Destructor. Removes this ObjMgrClient from the ObjMgr.

Member Function Documentation

◆ addAcceptedInfoLayerName()

void ml::ObjMgrClient::addAcceptedInfoLayerName ( const std::string & layerName )

inline

Add layer name to set of accepted layers (layerName can be a regular expression).

Definition at line 177 of file mlObjMgrClient.h.

◆ addAcceptedObjectID()

void ml::ObjMgrClient::addAcceptedObjectID ( const std::string & id )

inline

Add object ID to set of accepted objects (id can be a regular expression).

Definition at line 168 of file mlObjMgrClient.h.

◆ cancelObjMgrRegistration()

void ml::ObjMgrClient::cancelObjMgrRegistration ( )

protected

Remove registration of this and all connected modules from ObjMgr.

◆ cancelSourceModuleRegistration()

void ml::ObjMgrClient::cancelSourceModuleRegistration ( )

protected

Remove this module from the source module's container of connected modules.

◆ clearAcceptedInfoLayerNames()

void ml::ObjMgrClient::clearAcceptedInfoLayerNames ( )

inline

Clear set of accepted layers.

Definition at line 181 of file mlObjMgrClient.h.

◆ clearAcceptedObjectIDs()

void ml::ObjMgrClient::clearAcceptedObjectIDs ( )

inline

Clear set of accepted objects.

Definition at line 172 of file mlObjMgrClient.h.

◆ clearEventContainer()

void ml::ObjMgrClient::clearEventContainer ( )

inline

Clear event container.

This must be done, when the last event has been processed, by the module since the ObjMgr appends new events and never empties the container itself.

Definition at line 206 of file mlObjMgrClient.h.

◆ getConstObjContainer()

const omObjectContainer* ml::ObjMgrClient::getConstObjContainer ( ) const

inlineprotected

Definition at line 103 of file mlObjMgrClient.h.

◆ getDebugComment()

std::string ml::ObjMgrClient::getDebugComment ( ) const

inlineoverrideprotectedvirtual

Return debug comment.

Implements ml::ObjMgrBase.

Definition at line 120 of file mlObjMgrClient.h.

◆ getEventContainer()

const omEventContainer& ml::ObjMgrClient::getEventContainer ( ) const

inline

Get container with object manager events,.

Definition at line 199 of file mlObjMgrClient.h.

◆ getEventReceiveMode()

EventReceiveMode ml::ObjMgrClient::getEventReceiveMode ( )

inline

Returns current events receive mode settings.

Definition at line 190 of file mlObjMgrClient.h.

◆ getMutableEventContainer()

omEventContainer& ml::ObjMgrClient::getMutableEventContainer ( )

inlineprotected

Get read/write access to event container.

Definition at line 107 of file mlObjMgrClient.h.

◆ getObjContainer()

omObjectContainer* ml::ObjMgrClient::getObjContainer ( )

inlineprotected

Definition at line 104 of file mlObjMgrClient.h.

◆ handleNotification()

void ml::ObjMgrClient::handleNotification ( Field * field )

overrideprotectedvirtual

Called when a field in the field container is changed.

Derived classes must call its parent implementation of handleNotification() in front.

Reimplemented from ml::Module.

◆ handleObjMgrNotification()

virtual void ml::ObjMgrClient::handleObjMgrNotification ( )

inlineprotectedvirtual

This function is called when the connected ObjMgr sends out a notification.

Definition at line 98 of file mlObjMgrClient.h.

◆ objContainerChanged()

virtual void ml::ObjMgrClient::objContainerChanged ( )

inlineprotectedvirtual

This function is called when the objectContainer has been changed.

Definition at line 101 of file mlObjMgrClient.h.

◆ registerWithObjMgr()

void ml::ObjMgrClient::registerWithObjMgr ( )

protected

Register this and all connected modules with ObjMgr.

◆ registerWithSourceModule()

void ml::ObjMgrClient::registerWithSourceModule ( )

protected

Add this module to the source module's container of connected modules.

◆ sendNotification()

void ml::ObjMgrClient::sendNotification ( )

Send notification to all other modules connected to the ObjMgr.

This ObjMgrClient does not receive its own notification.

◆ setEventReceiveMode()

void ml::ObjMgrClient::setEventReceiveMode ( EventReceiveMode mode )

inline

Modify current events receive mode settings.

Definition at line 186 of file mlObjMgrClient.h.

Friends And Related Function Documentation

◆ ObjMgr

friend class ObjMgr

friend

Definition at line 48 of file mlObjMgrClient.h.

◆ ObjMgrBase

friend class ObjMgrBase

friend

Definition at line 49 of file mlObjMgrClient.h.

Member Data Documentation

◆ _acceptedInfoLayers

std::set<std::string> ml::ObjMgrClient::_acceptedInfoLayers

protected

Accept only events of layers that are stored in this set.

Definition at line 91 of file mlObjMgrClient.h.

◆ _acceptedObjects

std::set<std::string> ml::ObjMgrClient::_acceptedObjects

protected

Accept only events regarding objects stored in this set.

Definition at line 88 of file mlObjMgrClient.h.

◆ _eventReceiveMode

EventReceiveMode ml::ObjMgrClient::_eventReceiveMode

protected

Determines which events will be received.

Definition at line 85 of file mlObjMgrClient.h.

◆ _events

omEventContainer ml::ObjMgrClient::_events

protected

Container of changes that have occurred.

Definition at line 82 of file mlObjMgrClient.h.

◆ _objMgr

ObjMgr* ml::ObjMgrClient::_objMgr

protected

Pointer to ObjMgr object.

Definition at line 72 of file mlObjMgrClient.h.

◆ _skipNotificationCount

MLint32 ml::ObjMgrClient::_skipNotificationCount

protected

If the value is >= the notification recursion depth in the ObjMgr, the ObjMgrClient does not notify attached FieldListeners.

Connected modules, however, are still notified.

Definition at line 79 of file mlObjMgrClient.h.

◆ _sourceModule

ObjMgrBase* ml::ObjMgrClient::_sourceModule

protected

Pointer to module, to which this module is connected.

Definition at line 75 of file mlObjMgrClient.h.

◆ debugCommentFld

StringField* ml::ObjMgrClient::debugCommentFld

Value of this field is used in debug output to distinguish different instances.

Definition at line 162 of file mlObjMgrClient.h.

◆ EventReceiveModeStrings

const char* ml::ObjMgrClient::EventReceiveModeStrings[NUM_EVENT_RECEIVE_MODES]

static

Define strings for all event receive modes. These can be used for enum fields.

Definition at line 67 of file mlObjMgrClient.h.

◆ priorityFld

IntField* ml::ObjMgrClient::priorityFld

Priority determines the order in which events are send to ObjMgrClient modules. Default is 10000;.

Definition at line 159 of file mlObjMgrClient.h.

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

MeVisLab/Standard/Sources/ML/MLObjMgr/ObjMgr/mlObjMgrClient.h

Public Types

Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ EventReceiveMode

Constructor & Destructor Documentation

◆ ObjMgrClient()

◆ ~ObjMgrClient()

Member Function Documentation

◆ addAcceptedInfoLayerName()

◆ addAcceptedObjectID()

◆ cancelObjMgrRegistration()

◆ cancelSourceModuleRegistration()

◆ clearAcceptedInfoLayerNames()

◆ clearAcceptedObjectIDs()

◆ clearEventContainer()

◆ getConstObjContainer()

◆ getDebugComment()

◆ getEventContainer()

◆ getEventReceiveMode()

◆ getMutableEventContainer()

◆ getObjContainer()

◆ handleNotification()

◆ handleObjMgrNotification()

◆ objContainerChanged()

◆ registerWithObjMgr()

◆ registerWithSourceModule()

◆ sendNotification()

◆ setEventReceiveMode()

Friends And Related Function Documentation

◆ ObjMgr

◆ ObjMgrBase

Member Data Documentation

◆ _acceptedInfoLayers

◆ _acceptedObjects

◆ _eventReceiveMode

◆ _events

◆ _objMgr

◆ _skipNotificationCount

◆ _sourceModule

◆ debugCommentFld

◆ EventReceiveModeStrings

◆ priorityFld