<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta name="robots" content="noindex">
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>ITK: itk::EventObject Class Reference</title>
<link href="DoxygenStyle.css" rel="stylesheet" type="text/css">
</head><body bgcolor="#ffffff">
<!-- Section customized for INSIGHT : Tue Jul 17 01:02:45 2001 -->
<center>
<a href="index.html" class="qindex">Main Page</a>
<a href="modules.html" class="qindex">Groups</a>
<a href="namespaces.html" class="qindex">Namespace List</a>
<a href="hierarchy.html" class="qindex">Class Hierarchy</a>
<a href="classes.html" class="qindex">Alphabetical List</a>
<a href="annotated.html" class="qindex">Compound List</a>
<a href="files.html" class="qindex">File
List</a>
<a href="namespacemembers.html" class="qindex">Namespace Members</a>
<a href="functions.html" class="qindex">Compound Members</a>
<a href="globals.html" class="qindex">File Members</a>
<a href="pages.html" class="qindex">Concepts</a></center>
<!-- Generated by Doxygen 1.5.9 -->
<div class="navpath"><a class="el" href="namespaceitk.html">itk</a>::<a class="el" href="classitk_1_1EventObject.html">EventObject</a>
</div>
<div class="contents">
<h1>itk::EventObject Class Reference<br>
<small>
[<a class="el" href="group__ITKSystemObjects.html">ITK System Objects</a>]</small>
</h1><!-- doxytag: class="itk::EventObject" -->Abstraction of the Events used to communicating among filters and with GUIs.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="itkEventObject_8h_source.html">itkEventObject.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for itk::EventObject:</div>
<div class="dynsection">
<p><center><img src="classitk_1_1EventObject__inherit__graph.png" border="0" usemap="#itk_1_1EventObject__inherit__map" alt="Inheritance graph"></center>
<map name="itk_1_1EventObject__inherit__map">
<area shape="rect" id="node3" href="classitk_1_1AnyEvent.html" title="itk::AnyEvent" alt="" coords="192,272,307,301"><area shape="rect" id="node43" href="classitk_1_1NoEvent.html" title="itk::NoEvent" alt="" coords="196,325,303,355"><area shape="rect" id="node5" href="classitk_1_1AbortEvent.html" title="itk::AbortEvent" alt="" coords="369,5,495,35"><area shape="rect" id="node7" href="classitk_1_1DeleteEvent.html" title="itk::DeleteEvent" alt="" coords="364,59,500,88"><area shape="rect" id="node9" href="classitk_1_1EndEvent.html" title="itk::EndEvent" alt="" coords="375,112,489,141"><area shape="rect" id="node11" href="classitk_1_1ExitEvent.html" title="itk::ExitEvent" alt="" coords="375,165,489,195"><area shape="rect" id="node13" href="classitk_1_1InitializeEvent.html" title="itk::InitializeEvent" alt="" coords="360,219,504,248"><area shape="rect" id="node15" href="classitk_1_1IterationEvent.html" title="itk::IterationEvent" alt="" coords="359,272,505,301"><area shape="rect" id="node23" href="classitk_1_1ModifiedEvent.html" title="itk::ModifiedEvent" alt="" coords="360,325,504,355"><area shape="rect" id="node29" href="classitk_1_1PickEvent.html" title="itk::PickEvent" alt="" coords="375,379,489,408"><area shape="rect" id="node37" href="classitk_1_1ProgressEvent.html" title="itk::ProgressEvent" alt="" coords="359,432,505,461"><area shape="rect" id="node39" href="classitk_1_1StartEvent.html" title="itk::StartEvent" alt="" coords="371,485,493,515"><area shape="rect" id="node41" href="classitk_1_1UserEvent.html" title="itk::UserEvent" alt="" coords="372,539,492,568"><area shape="rect" id="node17" href="classitk_1_1FunctionAndGradientEvaluationIterationEvent.html" title="itk::FunctionAndGradientEvaluationIterationEvent" alt="" coords="559,124,916,153"><area shape="rect" id="node19" href="classitk_1_1FunctionEvaluationIterationEvent.html" title="itk::FunctionEvaluationIterationEvent" alt="" coords="600,177,875,207"><area shape="rect" id="node21" href="classitk_1_1GradientEvaluationIterationEvent.html" title="itk::GradientEvaluationIterationEvent" alt="" coords="600,231,875,260"><area shape="rect" id="node25" href="classitk_1_1TreeChangeEvent.html" title="This class derives from ModifiedEvent and check if the position of a node in the..." alt="" coords="604,325,871,355"><area shape="rect" id="node31" href="classitk_1_1AbortCheckEvent.html" title="itk::AbortCheckEvent" alt="" coords="653,379,821,408"><area shape="rect" id="node33" href="classitk_1_1EndPickEvent.html" title="itk::EndPickEvent" alt="" coords="667,432,808,461"><area shape="rect" id="node35" href="classitk_1_1StartPickEvent.html" title="itk::StartPickEvent" alt="" coords="661,485,813,515"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="classitk_1_1EventObject-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1EventObject.html#d77c5d41f21fb9cc2a9292f3bdb5804b">CheckEvent</a> (const <a class="el" href="classitk_1_1EventObject.html">EventObject</a> *) const =0</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1EventObject.html#14508f50843cb6d68cc082f8e7275ba3">EventObject</a> (const <a class="el" href="classitk_1_1EventObject.html">EventObject</a> &)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1EventObject.html#1aade1ad7373bc14fafb1be01f1fb6da">EventObject</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1EventObject.html#64aca64eadfb68d4f96ef98faa906531">GetEventName</a> (void) const =0</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classitk_1_1EventObject.html">EventObject</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1EventObject.html#9616cf83a3900f596a1a4bcf294fff9e">MakeObject</a> () const =0</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1EventObject.html#6e5d3b173e5cf942833cec8efa4d86fa">Print</a> (std::ostream &os) const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1EventObject.html#148060f4754fa366cb86b81571eb6d92">~EventObject</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1EventObject.html#f341093971d482affdc9279b46bcab8d">PrintHeader</a> (std::ostream &os, <a class="el" href="classitk_1_1Indent.html">Indent</a> indent) const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1EventObject.html#20b9addeef1f0cb296a94dc2e78ba19f">PrintSelf</a> (std::ostream &os, <a class="el" href="classitk_1_1Indent.html">Indent</a> indent) const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1EventObject.html#43ce6e64616322c315e1b1104176049a">PrintTrailer</a> (std::ostream &os, <a class="el" href="classitk_1_1Indent.html">Indent</a> indent) const </td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Abstraction of the Events used to communicating among filters and with GUIs.
<p>
<a class="el" href="classitk_1_1EventObject.html" title="Abstraction of the Events used to communicating among filters and with GUIs.">EventObject</a> provides a standard coding for sending and receiving messages indicating things like the initiation of processes, end of processes, modification of filters.<p>
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.<p>
EventObjects are used by <a class="el" href="classitk_1_1Command.html" title="superclass for callback/observer methods">itk::Command</a> and <a class="el" href="classitk_1_1Object.html" title="Base class for most itk classes.">itk::Object</a> for implementing the Observer/Subject design pattern. Observers register their interest in particular kinds of events produced by a specific <a class="el" href="classitk_1_1Object.html" title="Base class for most itk classes.">itk::Object</a>. This mechanism decouples classes among them.<p>
As oppossed to itk::Exception, <a class="el" href="classitk_1_1EventObject.html" title="Abstraction of the Events used to communicating among filters and with GUIs.">itk::EventObject</a> does not represent error states, but simply flow of information allowing to trigger actions as a consecuence of changes occurring in state on some itk::Objects.<p>
<a class="el" href="classitk_1_1EventObject.html" title="Abstraction of the Events used to communicating among filters and with GUIs.">itk::EventObject</a> carries information in its own type, it relies on the appropiate use of the RTTI (Run Time Type Information).<p>
<a class="el" href="classA.html">A</a> set of standard EventObjects is defined near the end of <a class="el" href="itkIndent_8h.html">itkIndent.h</a>.<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classitk_1_1Command.html" title="superclass for callback/observer methods">itk::Command</a> <p>
itk::ExceptionObject </dd></dl>
<p>Definition at line <a class="el" href="itkEventObject_8h_source.html#l00058">58</a> of file <a class="el" href="itkEventObject_8h_source.html">itkEventObject.h</a>.</p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="1aade1ad7373bc14fafb1be01f1fb6da"></a><!-- doxytag: member="itk::EventObject::EventObject" ref="1aade1ad7373bc14fafb1be01f1fb6da" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">itk::EventObject::EventObject </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constructor and copy constructor. Note that these functions will be called when children are instantiated.
<p>Definition at line <a class="el" href="itkEventObject_8h_source.html#l00063">63</a> of file <a class="el" href="itkEventObject_8h_source.html">itkEventObject.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="14508f50843cb6d68cc082f8e7275ba3"></a><!-- doxytag: member="itk::EventObject::EventObject" ref="14508f50843cb6d68cc082f8e7275ba3" args="(const EventObject &)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">itk::EventObject::EventObject </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classitk_1_1EventObject.html">EventObject</a> & </td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Definition at line <a class="el" href="itkEventObject_8h_source.html#l00065">65</a> of file <a class="el" href="itkEventObject_8h_source.html">itkEventObject.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="148060f4754fa366cb86b81571eb6d92"></a><!-- doxytag: member="itk::EventObject::~EventObject" ref="148060f4754fa366cb86b81571eb6d92" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual itk::EventObject::~EventObject </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Virtual destructor needed
<p>Definition at line <a class="el" href="itkEventObject_8h_source.html#l00068">68</a> of file <a class="el" href="itkEventObject_8h_source.html">itkEventObject.h</a>.</p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="d77c5d41f21fb9cc2a9292f3bdb5804b"></a><!-- doxytag: member="itk::EventObject::CheckEvent" ref="d77c5d41f21fb9cc2a9292f3bdb5804b" args="(const EventObject *) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool itk::EventObject::CheckEvent </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classitk_1_1EventObject.html">EventObject</a> * </td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Check if given event matches or derives from this event.
</div>
</div><p>
<a class="anchor" name="64aca64eadfb68d4f96ef98faa906531"></a><!-- doxytag: member="itk::EventObject::GetEventName" ref="64aca64eadfb68d4f96ef98faa906531" args="(void) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const char* itk::EventObject::GetEventName </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return the StringName associated with the event.
<p>Implemented in <a class="el" href="classitk_1_1TreeChangeEvent.html#0d146d889cfd3230a50069114e673c6f">itk::TreeChangeEvent< TTreeType ></a>, <a class="el" href="classitk_1_1TreeNodeChangeEvent.html#833abad82ff6e90aee68339be5303a8f">itk::TreeNodeChangeEvent< TTreeType ></a>, <a class="el" href="classitk_1_1TreeAddEvent.html#fba340ee02e8fab5b454800fedaf8f49">itk::TreeAddEvent< TTreeType ></a>, <a class="el" href="classitk_1_1TreeRemoveEvent.html#34790e57345d715655f79bdc892c43c5">itk::TreeRemoveEvent< TTreeType ></a>, <a class="el" href="classitk_1_1TreePruneEvent.html#04de2c6f10b5125cb2e24d2976081eb5">itk::TreePruneEvent< TTreeType ></a>, <a class="el" href="classitk_1_1TreeChangeEvent.html#0d146d889cfd3230a50069114e673c6f">itk::TreeChangeEvent< TTreeType ></a>, and <a class="el" href="classitk_1_1TreeRemoveEvent.html#34790e57345d715655f79bdc892c43c5">itk::TreeRemoveEvent< TTreeType ></a>.</p>
</div>
</div><p>
<a class="anchor" name="9616cf83a3900f596a1a4bcf294fff9e"></a><!-- doxytag: member="itk::EventObject::MakeObject" ref="9616cf83a3900f596a1a4bcf294fff9e" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classitk_1_1EventObject.html">EventObject</a>* itk::EventObject::MakeObject </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Create an Event of this type This method work as a Factory for creating events of each particular type.
<p>Implemented in <a class="el" href="classitk_1_1TreeChangeEvent.html#9dfbe5d70d96e5e5453247e36b687df0">itk::TreeChangeEvent< TTreeType ></a>, <a class="el" href="classitk_1_1TreeNodeChangeEvent.html#eaedd7712489869f1e2d1ae64373af95">itk::TreeNodeChangeEvent< TTreeType ></a>, <a class="el" href="classitk_1_1TreeAddEvent.html#239fbaa8d66ee09d0bbf1b0b9aeb588c">itk::TreeAddEvent< TTreeType ></a>, <a class="el" href="classitk_1_1TreeRemoveEvent.html#7f2b79bead0ecb863fc341e4bb5a0688">itk::TreeRemoveEvent< TTreeType ></a>, <a class="el" href="classitk_1_1TreePruneEvent.html#422a2a88b6ae137b9adc9049b5673137">itk::TreePruneEvent< TTreeType ></a>, <a class="el" href="classitk_1_1TreeChangeEvent.html#9dfbe5d70d96e5e5453247e36b687df0">itk::TreeChangeEvent< TTreeType ></a>, and <a class="el" href="classitk_1_1TreeRemoveEvent.html#7f2b79bead0ecb863fc341e4bb5a0688">itk::TreeRemoveEvent< TTreeType ></a>.</p>
</div>
</div><p>
<a class="anchor" name="6e5d3b173e5cf942833cec8efa4d86fa"></a><!-- doxytag: member="itk::EventObject::Print" ref="6e5d3b173e5cf942833cec8efa4d86fa" args="(std::ostream &os) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void itk::EventObject::Print </td>
<td>(</td>
<td class="paramtype">std::ostream & </td>
<td class="paramname"> <em>os</em> </td>
<td> ) </td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Print Event information. This method can be overridden by specific Event subtypes. The default is to print out the type of the event.
</div>
</div><p>
<a class="anchor" name="f341093971d482affdc9279b46bcab8d"></a><!-- doxytag: member="itk::EventObject::PrintHeader" ref="f341093971d482affdc9279b46bcab8d" args="(std::ostream &os, Indent indent) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void itk::EventObject::PrintHeader </td>
<td>(</td>
<td class="paramtype">std::ostream & </td>
<td class="paramname"> <em>os</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classitk_1_1Indent.html">Indent</a> </td>
<td class="paramname"> <em>indent</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const<code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Methods invoked by <a class="el" href="classitk_1_1EventObject.html#6e5d3b173e5cf942833cec8efa4d86fa">Print()</a> to print information about the object including superclasses. Typically not called by the user (use <a class="el" href="classitk_1_1EventObject.html#6e5d3b173e5cf942833cec8efa4d86fa">Print()</a> instead) but used in the hierarchical print process to combine the output of several classes.
</div>
</div><p>
<a class="anchor" name="20b9addeef1f0cb296a94dc2e78ba19f"></a><!-- doxytag: member="itk::EventObject::PrintSelf" ref="20b9addeef1f0cb296a94dc2e78ba19f" args="(std::ostream &os, Indent indent) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void itk::EventObject::PrintSelf </td>
<td>(</td>
<td class="paramtype">std::ostream & </td>
<td class="paramname"> <em>os</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classitk_1_1Indent.html">Indent</a> </td>
<td class="paramname"> <em>indent</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const<code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Methods invoked by <a class="el" href="classitk_1_1EventObject.html#6e5d3b173e5cf942833cec8efa4d86fa">Print()</a> to print information about the object including superclasses. Typically not called by the user (use <a class="el" href="classitk_1_1EventObject.html#6e5d3b173e5cf942833cec8efa4d86fa">Print()</a> instead) but used in the hierarchical print process to combine the output of several classes.
</div>
</div><p>
<a class="anchor" name="43ce6e64616322c315e1b1104176049a"></a><!-- doxytag: member="itk::EventObject::PrintTrailer" ref="43ce6e64616322c315e1b1104176049a" args="(std::ostream &os, Indent indent) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void itk::EventObject::PrintTrailer </td>
<td>(</td>
<td class="paramtype">std::ostream & </td>
<td class="paramname"> <em>os</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classitk_1_1Indent.html">Indent</a> </td>
<td class="paramname"> <em>indent</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const<code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Methods invoked by <a class="el" href="classitk_1_1EventObject.html#6e5d3b173e5cf942833cec8efa4d86fa">Print()</a> to print information about the object including superclasses. Typically not called by the user (use <a class="el" href="classitk_1_1EventObject.html#6e5d3b173e5cf942833cec8efa4d86fa">Print()</a> instead) but used in the hierarchical print process to combine the output of several classes.
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="itkEventObject_8h_source.html">itkEventObject.h</a></ul>
</div>
<hr><address><small>
Generated at Fri May 8 02:58:53 2009 for ITK by <a href="http://www.stack.nl/~dimitri/doxygen/index.html"> <img
src="http://www.stack.nl/~dimitri/doxygen/doxygen.png" alt="doxygen"
align="middle" border=0 width=110 height=53>
</a> 1.5.9 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>,
© 1997-2000</small></address>
</body>
</html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
d5e74628f0e673bb8680aebce32b2c04
>
files
>
2480
