MeVisLab Toolbox Reference
ml::ObjMgrEvent Class Reference

Event information. More...

#include <ObjMgr/mlObjMgrEvent.h>

Public Types

enum  EventType {
  NIL = 0 , OBJECT_CREATED , OBJECT_REMOVED , ATTRIBUTE_CREATED ,
  ATTRIBUTE_MODIFIED , ATTRIBUTE_REMOVED , CONNECTED_TO_DATABASE , NUM_EVENT_TYPES
}
 Notification types. More...
 

Public Member Functions

 ObjMgrEvent ()
 
 ObjMgrEvent (EventType _type, const omIDType &_objectID, const omIDType &_layerID, const omIDType &_infoID, const omFlags &_objectFlags, const omFlags &_layerFlags, const omFlags &_infoFlags, const omData &_newValue, const omData &_prevValue, bool _nonMaskable=false)
 
 ObjMgrEvent (EventType _type, void *_clientID, bool _nonMaskable=false)
 
 ObjMgrEvent (EventType _type, const omObject &_object, const omFlags &_flags, bool _nonMaskable=false)
 
 ObjMgrEvent (EventType _type, const omObject &_object, bool _nonMaskable=false)
 
 ObjMgrEvent (EventType _type, const omAttribute &_attribute, const omFlags &_flags, bool _nonMaskable=false)
 
 ObjMgrEvent (EventType _type, const omAttribute &_attribute, bool _nonMaskable=false)
 
 ObjMgrEvent (EventType _type, const omAttribute &_attribute, const omFlags &_flags, const omData &_newValue, bool _nonMaskable=false)
 
 ObjMgrEvent (EventType _type, const omAttribute &_attribute, const omData &_newValue, bool _nonMaskable=false)
 
 ObjMgrEvent (EventType _type, const omAttribute &_attribute, const omFlags &_flags, const omData &_newValue, const omData &_prevValue, bool _nonMaskable=false)
 
 ObjMgrEvent (EventType _type, const omAttribute &_attribute, const omData &_newValue, const omData &_prevValue, bool _nonMaskable=false)
 
bool operator== (const ObjMgrEvent &ev) const
 The special address flags are not evaluated to determine identity! More...
 

Public Attributes

EventType type
 What kind of modification to the object (container) has been made. More...
 
bool nonMaskable
 Specifies whether or not an event can be filtered out. More...
 
size_t clientID
 ID of client that should receive the event, or 0 for any client. More...
 
omIDType objectID
 ID of object that has been modified. More...
 
omIDType layerID
 ID of layer that has been modified. More...
 
omIDType infoID
 ID of information item that has been modified. More...
 
omFlags objectFlags
 Special address flags. More...
 
omFlags layerFlags
 
omFlags infoFlags
 
omData newValue
 New value. More...
 
omData prevValue
 Previous value. More...
 

Static Public Attributes

static const char * EventTypeStrings [NUM_EVENT_TYPES]
 Define strings for all event types. These can be used for enum fields. More...
 

Detailed Description

Event information.

Definition at line 32 of file mlObjMgrEvent.h.

Member Enumeration Documentation

◆ EventType

Notification types.

Enumerator
NIL 
OBJECT_CREATED 
OBJECT_REMOVED 
ATTRIBUTE_CREATED 
ATTRIBUTE_MODIFIED 
ATTRIBUTE_REMOVED 
CONNECTED_TO_DATABASE 
NUM_EVENT_TYPES 

Definition at line 37 of file mlObjMgrEvent.h.

Constructor & Destructor Documentation

◆ ObjMgrEvent() [1/11]

ml::ObjMgrEvent::ObjMgrEvent ( )
inline

Definition at line 79 of file mlObjMgrEvent.h.

◆ ObjMgrEvent() [2/11]

ml::ObjMgrEvent::ObjMgrEvent ( EventType  _type,
const omIDType _objectID,
const omIDType _layerID,
const omIDType _infoID,
const omFlags _objectFlags,
const omFlags _layerFlags,
const omFlags _infoFlags,
const omData _newValue,
const omData _prevValue,
bool  _nonMaskable = false 
)
inline

Definition at line 81 of file mlObjMgrEvent.h.

◆ ObjMgrEvent() [3/11]

ml::ObjMgrEvent::ObjMgrEvent ( EventType  _type,
void *  _clientID,
bool  _nonMaskable = false 
)

◆ ObjMgrEvent() [4/11]

ml::ObjMgrEvent::ObjMgrEvent ( EventType  _type,
const omObject _object,
const omFlags _flags,
bool  _nonMaskable = false 
)

◆ ObjMgrEvent() [5/11]

ml::ObjMgrEvent::ObjMgrEvent ( EventType  _type,
const omObject _object,
bool  _nonMaskable = false 
)

◆ ObjMgrEvent() [6/11]

ml::ObjMgrEvent::ObjMgrEvent ( EventType  _type,
const omAttribute _attribute,
const omFlags _flags,
bool  _nonMaskable = false 
)

◆ ObjMgrEvent() [7/11]

ml::ObjMgrEvent::ObjMgrEvent ( EventType  _type,
const omAttribute _attribute,
bool  _nonMaskable = false 
)

◆ ObjMgrEvent() [8/11]

ml::ObjMgrEvent::ObjMgrEvent ( EventType  _type,
const omAttribute _attribute,
const omFlags _flags,
const omData _newValue,
bool  _nonMaskable = false 
)

◆ ObjMgrEvent() [9/11]

ml::ObjMgrEvent::ObjMgrEvent ( EventType  _type,
const omAttribute _attribute,
const omData _newValue,
bool  _nonMaskable = false 
)

◆ ObjMgrEvent() [10/11]

ml::ObjMgrEvent::ObjMgrEvent ( EventType  _type,
const omAttribute _attribute,
const omFlags _flags,
const omData _newValue,
const omData _prevValue,
bool  _nonMaskable = false 
)

◆ ObjMgrEvent() [11/11]

ml::ObjMgrEvent::ObjMgrEvent ( EventType  _type,
const omAttribute _attribute,
const omData _newValue,
const omData _prevValue,
bool  _nonMaskable = false 
)

Member Function Documentation

◆ operator==()

bool ml::ObjMgrEvent::operator== ( const ObjMgrEvent ev) const

The special address flags are not evaluated to determine identity!

Member Data Documentation

◆ clientID

size_t ml::ObjMgrEvent::clientID

ID of client that should receive the event, or 0 for any client.

Definition at line 60 of file mlObjMgrEvent.h.

◆ EventTypeStrings

const char* ml::ObjMgrEvent::EventTypeStrings[NUM_EVENT_TYPES]
static

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

Definition at line 49 of file mlObjMgrEvent.h.

◆ infoFlags

omFlags ml::ObjMgrEvent::infoFlags

Definition at line 72 of file mlObjMgrEvent.h.

◆ infoID

omIDType ml::ObjMgrEvent::infoID

ID of information item that has been modified.

Definition at line 67 of file mlObjMgrEvent.h.

◆ layerFlags

omFlags ml::ObjMgrEvent::layerFlags

Definition at line 71 of file mlObjMgrEvent.h.

◆ layerID

omIDType ml::ObjMgrEvent::layerID

ID of layer that has been modified.

Definition at line 65 of file mlObjMgrEvent.h.

◆ newValue

omData ml::ObjMgrEvent::newValue

New value.

Definition at line 75 of file mlObjMgrEvent.h.

◆ nonMaskable

bool ml::ObjMgrEvent::nonMaskable

Specifies whether or not an event can be filtered out.

Definition at line 57 of file mlObjMgrEvent.h.

◆ objectFlags

omFlags ml::ObjMgrEvent::objectFlags

Special address flags.

Definition at line 70 of file mlObjMgrEvent.h.

◆ objectID

omIDType ml::ObjMgrEvent::objectID

ID of object that has been modified.

Definition at line 63 of file mlObjMgrEvent.h.

◆ prevValue

omData ml::ObjMgrEvent::prevValue

Previous value.

Definition at line 77 of file mlObjMgrEvent.h.

◆ type

EventType ml::ObjMgrEvent::type

What kind of modification to the object (container) has been made.

Definition at line 54 of file mlObjMgrEvent.h.


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