#include <ossimEvent.h>
Public Types | |
| enum | PropagationType { PROPAGATION_NONE = 0, PROPAGATION_INPUT = 1, PROPAGATION_OUTPUT = 2 } |
Public Member Functions | |
| ossimEvent (ossimObject *object=NULL, long id=OSSIM_EVENT_NULL_ID) | |
| ossimEvent (const ossimEvent &rhs) | |
| long | getId () const |
| void | setId (long id) |
| bool | isConsumed () const |
| void | setConsumedFlag (bool flag=true) |
| void | consume () |
| const ossimObject * | getObject () const |
| This is the originating object that originally produced the event. More... | |
| ossimObject * | getObject () |
| const ossimObject * | getCurrentObject () const |
| ossimObject * | getCurrentObject () |
| void | setObject (ossimObject *object) |
| void | setCurrentObject (ossimObject *object) |
| void | setPropagationType (PropagationType type) |
| bool | isPropagatingToOutputs () const |
| bool | isPropagatingToInputs () const |
 Public Member Functions inherited from ossimObject | |
| ossimObject () | |
| virtual | ~ossimObject () |
| virtual ossimObject * | dup () const |
| virtual ossimString | getShortName () const |
| virtual ossimString | getLongName () const |
| virtual ossimString | getDescription () const |
| virtual ossimString | getClassName () const |
| virtual RTTItypeid | getType () const |
| virtual bool | canCastTo (ossimObject *obj) const |
| virtual bool | canCastTo (const RTTItypeid &id) const |
| virtual bool | canCastTo (const ossimString &parentClassName) const |
| virtual bool | saveState (ossimKeywordlist &kwl, const char *prefix=0) const |
| virtual bool | loadState (const ossimKeywordlist &kwl, const char *prefix=0) |
| virtual std::ostream & | print (std::ostream &out) const |
| Generic print method. More... | |
| virtual bool | isEqualTo (const ossimObject &obj, ossimCompareType compareType=OSSIM_COMPARE_FULL) const |
| virtual void | accept (ossimVisitor &visitor) |
| Public Member Functions inherited from ossimReferenced | |
| ossimReferenced () | |
| ossimReferenced (const ossimReferenced &) | |
| ossimReferenced & | operator= (const ossimReferenced &) |
| void | ref () const |
| increment the reference count by one, indicating that this object has another pointer which is referencing it. More... | |
| void | unref () const |
| decrement the reference count by one, indicating that a pointer to this object is referencing it. More... | |
| void | unref_nodelete () const |
| decrement the reference count by one, indicating that a pointer to this object is referencing it. More... | |
| int | referenceCount () const |
Protected Attributes | |
| ossimObject * | theObject |
| ossimObject * | theCurrentObject |
| long | theId |
| bool | theIsConsumedFlag |
| PropagationType | thePropagationType |
Additional Inherited Members | |
| Protected Member Functions inherited from ossimReferenced | |
| virtual | ~ossimReferenced () |
Detailed Description
Definition at line 16 of file ossimEvent.h.
Member Enumeration Documentation
◆ PropagationType
| Enumerator | |
|---|---|
| PROPAGATION_NONE | |
| PROPAGATION_INPUT | |
| PROPAGATION_OUTPUT | |
Definition at line 19 of file ossimEvent.h.
Constructor & Destructor Documentation
◆ ossimEvent() [1/2]
| ossimEvent::ossimEvent | ( | ossimObject * | object = NULL, |
| long | id = OSSIM_EVENT_NULL_ID |
||
| ) |
- Parameters
-
object The object associated with the event if any. id The event id.
Definition at line 16 of file ossimEvent.cpp.
◆ ossimEvent() [2/2]
| ossimEvent::ossimEvent | ( | const ossimEvent & | rhs | ) |
Definition at line 27 of file ossimEvent.cpp.
Member Function Documentation
◆ consume()
| void ossimEvent::consume | ( | ) |
◆ getCurrentObject() [1/2]
| const ossimObject * ossimEvent::getCurrentObject | ( | ) | const |
Definition at line 74 of file ossimEvent.cpp.
References theCurrentObject.
Referenced by ossimImageChain::processEvent().
◆ getCurrentObject() [2/2]
| ossimObject * ossimEvent::getCurrentObject | ( | ) |
◆ getId()
| long ossimEvent::getId | ( | ) | const |
Definition at line 39 of file ossimEvent.cpp.
References theId.
Referenced by ossimConnectionEvent::isConnect(), ossimConnectionEvent::isDisconnect(), ossimImageGeometryEventListener::processEvent(), ossimImageAoiListener::processEvent(), ossimProcessListener::processEvent(), ossimConnectableObjectListener::processEvent(), and ossimConnectableDisplayListener::processEvent().
◆ getObject() [1/2]
| const ossimObject * ossimEvent::getObject | ( | ) | const |
This is the originating object that originally produced the event.
Definition at line 64 of file ossimEvent.cpp.
References theObject.
Referenced by ossimHistogramWriter::connectInputEvent(), ossimImageChain::connectInputEvent(), ossimImageChain::disconnectInputEvent(), ossimConnectableContainerChildListener::objectDestructingEvent(), ossimImageChain::objectDestructingEvent(), ossimHistogramWriter::processProgressEvent(), ossimConnectableContainerChildListener::propagatePropertyEvent(), and ossimImageRenderer::refreshEvent().
◆ getObject() [2/2]
| ossimObject * ossimEvent::getObject | ( | ) |
◆ isConsumed()
| bool ossimEvent::isConsumed | ( | ) | const |
Definition at line 49 of file ossimEvent.cpp.
References theIsConsumedFlag.
Referenced by ossimListenerManager::fireEvent(), and ossimROIEventListener::processEvent().
◆ isPropagatingToInputs()
| bool ossimEvent::isPropagatingToInputs | ( | ) | const |
Definition at line 104 of file ossimEvent.cpp.
References PROPAGATION_INPUT, and thePropagationType.
◆ isPropagatingToOutputs()
| bool ossimEvent::isPropagatingToOutputs | ( | ) | const |
Definition at line 99 of file ossimEvent.cpp.
References PROPAGATION_OUTPUT, and thePropagationType.
Referenced by ossimImageChain::processEvent().
◆ setConsumedFlag()
| void ossimEvent::setConsumedFlag | ( | bool | flag = true | ) |
Definition at line 54 of file ossimEvent.cpp.
References theIsConsumedFlag.
Referenced by consume().
◆ setCurrentObject()
| void ossimEvent::setCurrentObject | ( | ossimObject * | object | ) |
◆ setId()
| void ossimEvent::setId | ( | long | id | ) |
Definition at line 44 of file ossimEvent.cpp.
References theId.
◆ setObject()
| void ossimEvent::setObject | ( | ossimObject * | object | ) |
◆ setPropagationType()
| void ossimEvent::setPropagationType | ( | PropagationType | type | ) |
Member Data Documentation
◆ theCurrentObject
|
protected |
Definition at line 59 of file ossimEvent.h.
Referenced by getCurrentObject(), and setCurrentObject().
◆ theId
|
protected |
Definition at line 60 of file ossimEvent.h.
◆ theIsConsumedFlag
|
protected |
Definition at line 61 of file ossimEvent.h.
Referenced by isConsumed(), and setConsumedFlag().
◆ theObject
|
protected |
Definition at line 58 of file ossimEvent.h.
Referenced by getObject(), and setObject().
◆ thePropagationType
|
protected |
Definition at line 62 of file ossimEvent.h.
Referenced by isPropagatingToInputs(), isPropagatingToOutputs(), and setPropagationType().
The documentation for this class was generated from the following files:
