MeVisLabToolboxReference
ml::ObjMgrEvent Class Reference

Event information. More...

#include <ObjMgr/mlObjMgrEvent.h>

List of all members.

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!

Public Attributes

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

Static Public Attributes

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

Detailed Description

Event information.

Definition at line 36 of file mlObjMgrEvent.h.


Member Enumeration Documentation

Notification types.

Enumerator:
NIL 
OBJECT_CREATED 
OBJECT_REMOVED 
ATTRIBUTE_CREATED 
ATTRIBUTE_MODIFIED 
ATTRIBUTE_REMOVED 
CONNECTED_TO_DATABASE 
NUM_EVENT_TYPES 

Definition at line 41 of file mlObjMgrEvent.h.


Constructor & Destructor Documentation

ml::ObjMgrEvent::ObjMgrEvent ( ) [inline]

Definition at line 83 of file mlObjMgrEvent.h.

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 85 of file mlObjMgrEvent.h.

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

Member Function Documentation

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

The special address flags are not evaluated to determine identity!


Member Data Documentation

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

Definition at line 64 of file mlObjMgrEvent.h.

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 53 of file mlObjMgrEvent.h.

ID of information item that has been modified.

Definition at line 71 of file mlObjMgrEvent.h.

ID of layer that has been modified.

Definition at line 69 of file mlObjMgrEvent.h.

New value.

Definition at line 79 of file mlObjMgrEvent.h.

Specifies whether or not an event can be filtered out.

Definition at line 61 of file mlObjMgrEvent.h.

Special address flags.

Definition at line 74 of file mlObjMgrEvent.h.

ID of object that has been modified.

Definition at line 67 of file mlObjMgrEvent.h.

Previous value.

Definition at line 81 of file mlObjMgrEvent.h.

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

Definition at line 58 of file mlObjMgrEvent.h.


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