Orfeo Toolbox  4.0
Public Member Functions | Protected Member Functions | Private Types | Private Member Functions | List of all members
itk::EventObject Class Referenceabstract

Abstraction of the Events used to communicating among filters and with GUIs. More...

#include <itkEventObject.h>

+ Inheritance diagram for itk::EventObject:

Public Member Functions

 EventObject ()
 
 EventObject (const EventObject &)
 
virtual ~EventObject ()
 
virtual bool CheckEvent (const EventObject *) const =0
 
virtual const char * GetEventName (void) const =0
 
virtual EventObjectMakeObject () const =0
 
virtual void Print (std::ostream &os) const
 

Protected Member Functions

virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintSelf (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 

Private Types

typedef EventObjectEventFactoryFunction ()
 

Private Member Functions

void operator= (const EventObject &)
 

Detailed Description

Abstraction of the Events used to communicating among filters and with GUIs.

EventObject provides a standard coding for sending and receiving messages indicating things like the initiation of processes, end of processes, modification of filters.

EventObjects form a hierarchy similar to the itk::ExceptionObject allowing to factorize common events in a tree-like structure. Higher detail can be assigned by users by subclassing existing itk::EventObjects.

EventObjects are used by itk::Command and itk::Object for implementing the Observer/Subject design pattern. Observers register their interest in particular kinds of events produced by a specific itk::Object. This mechanism decouples classes among them.

As opposed to itk::Exception, itk::EventObject does not represent error states, but simply flow of information allowing to trigger actions as a consequence of changes occurring in state on some itk::Objects.

itk::EventObject carries information in its own type, it relies on the appropriate use of the RTTI (Run Time Type Information).

A set of standard EventObjects is defined near the end of itkEventObject.h.

See Also
itk::Command
itk::ExceptionObject

Definition at line 57 of file itkEventObject.h.

Member Typedef Documentation

typedef EventObject* itk::EventObject::EventFactoryFunction()
private

Definition at line 96 of file itkEventObject.h.

Constructor & Destructor Documentation

itk::EventObject::EventObject ( )
inline

Constructor and copy constructor. Note that these functions will be called when children are instantiated.

Definition at line 62 of file itkEventObject.h.

itk::EventObject::EventObject ( const EventObject )
inline

Definition at line 64 of file itkEventObject.h.

virtual itk::EventObject::~EventObject ( )
inlinevirtual

Virtual destructor needed

Definition at line 67 of file itkEventObject.h.

Member Function Documentation

virtual bool itk::EventObject::CheckEvent ( const EventObject ) const
pure virtual

Check if given event matches or derives from this event.

Implemented in otb::Wrapper::AddProcessToWatchEvent.

Referenced by itk::SubjectImplementation::HasObserver(), and itk::SubjectImplementation::InvokeEvent().

virtual const char* itk::EventObject::GetEventName ( void  ) const
pure virtual
virtual EventObject* itk::EventObject::MakeObject ( ) const
pure virtual
void itk::EventObject::operator= ( const EventObject )
private
void itk::EventObject::Print ( std::ostream &  os) const
virtual

Print Event information. This method can be overridden by specific Event subtypes. The default is to print out the type of the event.

Definition at line 24 of file itkEventObject.cxx.

References itk::Indent::GetNextIndent().

void itk::EventObject::PrintHeader ( std::ostream &  os,
Indent  indent 
) const
protectedvirtual

Define a default print header for all objects.

Definition at line 38 of file itkEventObject.cxx.

void itk::EventObject::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
protectedvirtual

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Definition at line 56 of file itkEventObject.cxx.

void itk::EventObject::PrintTrailer ( std::ostream &  os,
Indent  indent 
) const
protectedvirtual

Define a default print trailer for all objects.

Definition at line 49 of file itkEventObject.cxx.


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

Generated at Sat Mar 8 2014 16:57:12 for Orfeo Toolbox with doxygen 1.8.3.1