<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <title>HippoDraw Class Library</title> <link href="doxygen.css" rel="stylesheet" type="text/css"> <link href="tabs.css" rel="stylesheet" type="text/css"> <link rel="shortcut icon" href="hippoApp.ico"> </head><body> <!-- Generated by Doxygen 1.6.2 --> <div class="navigation" id="top"> <div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li class="current"><a href="annotated.html"><span>Classes</span></a></li> <li><a href="files.html"><span>Files</span></a></li> <li><a href="dirs.html"><span>Directories</span></a></li> </ul> </div> <div class="tabs"> <ul> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="classes.html"><span>Class Index</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> <div class="navpath"><a class="el" href="namespacehippodraw.html">hippodraw</a>::<a class="el" href="classhippodraw_1_1ObserverWrap.html">ObserverWrap</a> </div> </div> <div class="contents"> <h1>ObserverWrap Class Reference</h1><!-- doxytag: class="hippodraw::ObserverWrap" --><!-- doxytag: inherits="hippodraw::Observer,boost::python::wrapper" --> <p>A wrapper class for <a class="el" href="classhippodraw_1_1Observer.html" title="Part of an implementation of the Observable Observer pattern based on the example...">Observer</a> to allow its pure virtual function to be implemented in <a class="el" href="namespacehippodraw_1_1Python.html" title="A namespace encapsulating functions to interface HippoDraw classes to Python using...">Python</a>. <a href="#_details">More...</a></p> <p><code>#include <<a class="el" href="ObserverWrap_8h_source.html">ObserverWrap.h</a>></code></p> <div class="dynheader"> Inheritance diagram for ObserverWrap:</div> <div class="dynsection"> <div class="center"><img src="classhippodraw_1_1ObserverWrap__inherit__graph.gif" border="0" usemap="#ObserverWrap_inherit__map" alt="Inheritance graph"/></div> <map name="ObserverWrap_inherit__map" id="ObserverWrap_inherit__map"> <area shape="rect" id="node2" href="classhippodraw_1_1Observer.html" title="Part of an implementation of the Observable Observer pattern based on the example..." alt="" coords="5,5,80,35"/><area shape="rect" id="node4" href="classboost_1_1python_1_1wrapper.html" title="wrapper\< hippodraw::Observer \>" alt="" coords="104,5,315,35"/></map> <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div> <div class="dynheader"> Collaboration diagram for ObserverWrap:</div> <div class="dynsection"> <div class="center"><img src="classhippodraw_1_1ObserverWrap__coll__graph.gif" border="0" usemap="#ObserverWrap_coll__map" alt="Collaboration graph"/></div> <map name="ObserverWrap_coll__map" id="ObserverWrap_coll__map"> <area shape="rect" id="node2" href="classhippodraw_1_1Observer.html" title="Part of an implementation of the Observable Observer pattern based on the example..." alt="" coords="5,5,80,35"/><area shape="rect" id="node4" href="classboost_1_1python_1_1wrapper.html" title="wrapper\< hippodraw::Observer \>" alt="" coords="104,5,315,35"/></map> <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div> <p><a href="classhippodraw_1_1ObserverWrap-members.html">List of all members.</a></p> <table border="0" cellpadding="0" cellspacing="0"> <tr><td colspan="2"><h2>Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classhippodraw_1_1ObserverWrap.html#a3b10e01e83ba9d53db29327912bb6e40">ObserverWrap</a> (const <a class="el" href="classhippodraw_1_1Observer.html">Observer</a> &)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classhippodraw_1_1ObserverWrap.html#a98975d353df86cc5c0cae9c13d3e7c1c">ObserverWrap</a> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classhippodraw_1_1ObserverWrap.html#a90d446da2e16fc7a7b639d3db6de242c">ObserverWrap</a> (PyObject *self)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">The constructor. <a href="#a90d446da2e16fc7a7b639d3db6de242c"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classhippodraw_1_1ObserverWrap.html#ae6b85d8f95c1889865463b18e33d08a5">update</a> (const <a class="el" href="classhippodraw_1_1Observable.html">Observable</a> *)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classhippodraw_1_1Observer.html#a5380948822be75c060ae8cc538cd1327">willDelete</a> (const <a class="el" href="classhippodraw_1_1Observable.html">Observable</a> *)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Notifies <code>this</code> <a class="el" href="classhippodraw_1_1Observer.html" title="Part of an implementation of the Observable Observer pattern based on the example...">Observer</a> object that one of its <a class="el" href="classhippodraw_1_1Observable.html" title="Part of an implementation of the Observable-Observer pattern based on the example...">Observable</a> objects is about to be deleted. <a href="#a5380948822be75c060ae8cc538cd1327"></a><br/></td></tr> <tr><td colspan="2"><h2>Private Member Functions</h2></td></tr> <tr><td class="memTemplParams" colspan="2">template<class T > </td></tr> <tr><td class="memTemplItemLeft" align="right" valign="top">boost::python::object </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classhippodraw_1_1ObserverWrap.html#a6890ec978e2c0d41a8b9e205a5798195">get_owner</a> (T *me) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Find the <a class="el" href="namespacehippodraw_1_1Python.html" title="A namespace encapsulating functions to interface HippoDraw classes to Python using...">Python</a> object that owns this object. <a href="#a6890ec978e2c0d41a8b9e205a5798195"></a><br/></td></tr> <tr><td colspan="2"><h2>Private Attributes</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">PyObject * </td><td class="memItemRight" valign="bottom"><a class="el" href="classhippodraw_1_1ObserverWrap.html#a931e04f416b41144ed7eab6cb9326d2a">m_self</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">The held <a class="el" href="namespacehippodraw_1_1Python.html" title="A namespace encapsulating functions to interface HippoDraw classes to Python using...">Python</a> object. <a href="#a931e04f416b41144ed7eab6cb9326d2a"></a><br/></td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <p>A wrapper class for <a class="el" href="classhippodraw_1_1Observer.html" title="Part of an implementation of the Observable Observer pattern based on the example...">Observer</a> to allow its pure virtual function to be implemented in <a class="el" href="namespacehippodraw_1_1Python.html" title="A namespace encapsulating functions to interface HippoDraw classes to Python using...">Python</a>. </p> <dl class="note"><dt><b>Note:</b></dt><dd>This class needs <a class="el" href="namespacehippodraw_1_1Python.html" title="A namespace encapsulating functions to interface HippoDraw classes to Python using...">Python</a> 2.3 or later to be fully functional.</dd></dl> <dl class="author"><dt><b>Author:</b></dt><dd>Paul F. Kunz <<a href="mailto:Paul_Kunz@slac.stanford.edu">Paul_Kunz@slac.stanford.edu</a>> </dd></dl> <p>Definition at line <a class="el" href="ObserverWrap_8h_source.html#l00029">29</a> of file <a class="el" href="ObserverWrap_8h_source.html">ObserverWrap.h</a>.</p> <hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="a90d446da2e16fc7a7b639d3db6de242c"></a><!-- doxytag: member="hippodraw::ObserverWrap::ObserverWrap" ref="a90d446da2e16fc7a7b639d3db6de242c" args="(PyObject *self)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classhippodraw_1_1ObserverWrap.html">ObserverWrap</a> </td> <td>(</td> <td class="paramtype">PyObject * </td> <td class="paramname"> <em>self</em></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>The constructor. </p> <dl class="todo"><dt><b><a class="el" href="todo.html#_todo000125">Todo:</a></b></dt><dd>This method and others may not be needed. </dd></dl> <p>Definition at line <a class="el" href="ObserverWrap_8cxx_source.html#l00060">60</a> of file <a class="el" href="ObserverWrap_8cxx_source.html">ObserverWrap.cxx</a>.</p> </div> </div> <a class="anchor" id="a98975d353df86cc5c0cae9c13d3e7c1c"></a><!-- doxytag: member="hippodraw::ObserverWrap::ObserverWrap" ref="a98975d353df86cc5c0cae9c13d3e7c1c" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classhippodraw_1_1ObserverWrap.html">ObserverWrap</a> </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Definition at line <a class="el" href="ObserverWrap_8cxx_source.html#l00067">67</a> of file <a class="el" href="ObserverWrap_8cxx_source.html">ObserverWrap.cxx</a>.</p> </div> </div> <a class="anchor" id="a3b10e01e83ba9d53db29327912bb6e40"></a><!-- doxytag: member="hippodraw::ObserverWrap::ObserverWrap" ref="a3b10e01e83ba9d53db29327912bb6e40" args="(const Observer &)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classhippodraw_1_1ObserverWrap.html">ObserverWrap</a> </td> <td>(</td> <td class="paramtype">const <a class="el" href="classhippodraw_1_1Observer.html">Observer</a> & </td> <td class="paramname"> <em>ow</em></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Definition at line <a class="el" href="ObserverWrap_8cxx_source.html#l00073">73</a> of file <a class="el" href="ObserverWrap_8cxx_source.html">ObserverWrap.cxx</a>.</p> </div> </div> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="a6890ec978e2c0d41a8b9e205a5798195"></a><!-- doxytag: member="hippodraw::ObserverWrap::get_owner" ref="a6890ec978e2c0d41a8b9e205a5798195" args="(T *me) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">object get_owner </td> <td>(</td> <td class="paramtype">T * </td> <td class="paramname"> <em>me</em></td> <td> ) </td> <td> const<code> [inline, private]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Find the <a class="el" href="namespacehippodraw_1_1Python.html" title="A namespace encapsulating functions to interface HippoDraw classes to Python using...">Python</a> object that owns this object. </p> <p>Definition at line <a class="el" href="ObserverWrap_8cxx_source.html#l00082">82</a> of file <a class="el" href="ObserverWrap_8cxx_source.html">ObserverWrap.cxx</a>.</p> <p>Referenced by <a class="el" href="ObserverWrap_8cxx_source.html#l00095">ObserverWrap::update()</a>.</p> </div> </div> <a class="anchor" id="ae6b85d8f95c1889865463b18e33d08a5"></a><!-- doxytag: member="hippodraw::ObserverWrap::update" ref="ae6b85d8f95c1889865463b18e33d08a5" args="(const Observable *)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void update </td> <td>(</td> <td class="paramtype">const <a class="el" href="classhippodraw_1_1Observable.html">Observable</a> * </td> <td class="paramname"> <em>obs</em></td> <td> ) </td> <td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <dl class="note"><dt><b>Note:</b></dt><dd>This function is only available with <a class="el" href="namespacehippodraw_1_1Python.html" title="A namespace encapsulating functions to interface HippoDraw classes to Python using...">Python</a> 2.3 or later. </dd></dl> <p>Implements <a class="el" href="classhippodraw_1_1Observer.html#ab42954b72ba11d6f27a226f712ea77be">Observer</a>.</p> <p>Definition at line <a class="el" href="ObserverWrap_8cxx_source.html#l00095">95</a> of file <a class="el" href="ObserverWrap_8cxx_source.html">ObserverWrap.cxx</a>.</p> <p>References <a class="el" href="ObserverWrap_8cxx_source.html#l00082">ObserverWrap::get_owner()</a>.</p> </div> </div> <a class="anchor" id="a5380948822be75c060ae8cc538cd1327"></a><!-- doxytag: member="hippodraw::ObserverWrap::willDelete" ref="a5380948822be75c060ae8cc538cd1327" args="(const Observable *)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void willDelete </td> <td>(</td> <td class="paramtype">const <a class="el" href="classhippodraw_1_1Observable.html">Observable</a> * </td> <td class="paramname"></td> <td> ) </td> <td><code> [virtual, inherited]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Notifies <code>this</code> <a class="el" href="classhippodraw_1_1Observer.html" title="Part of an implementation of the Observable Observer pattern based on the example...">Observer</a> object that one of its <a class="el" href="classhippodraw_1_1Observable.html" title="Part of an implementation of the Observable-Observer pattern based on the example...">Observable</a> objects is about to be deleted. </p> <p>Since most <a class="el" href="classhippodraw_1_1Observable.html" title="Part of an implementation of the Observable-Observer pattern based on the example...">Observable</a> objects are owned by its <a class="el" href="classhippodraw_1_1Observer.html" title="Part of an implementation of the Observable Observer pattern based on the example...">Observer</a>, it is the <a class="el" href="classhippodraw_1_1Observer.html" title="Part of an implementation of the Observable Observer pattern based on the example...">Observer</a> that issued the delete. Thus the default implementation here does nothing. Derived classes that observe objects owned by another should implement this method to remove the <a class="el" href="classhippodraw_1_1Observable.html" title="Part of an implementation of the Observable-Observer pattern based on the example...">Observable</a> from the list they are observing. </p> <p>Reimplemented in <a class="el" href="classhippodraw_1_1FunctionRep.html#a7e322f64d0478fb7242050addc7cce53">FunctionRep</a>, <a class="el" href="classhippodraw_1_1DataSourceController.html#a9ecb59d06196f351e82553081eb39207">DataSourceController</a>, <a class="el" href="classhippodraw_1_1ViewBase.html#a6ace0de18514ca0d0b5c9d331bde7f36">ViewBase</a>, <a class="el" href="classhippodraw_1_1CutPlotter.html#a486e625e490369e6e75cce2e38ed1774">CutPlotter</a>, <a class="el" href="classhippodraw_1_1TextPlotter.html#a486e625e490369e6e75cce2e38ed1774">TextPlotter</a>, <a class="el" href="classhippodraw_1_1BinningProjector.html#af844b7651dc35543e5b0904e3153db16">BinningProjector</a>, <a class="el" href="classhippodraw_1_1DyHist1DProjector.html#af844b7651dc35543e5b0904e3153db16">DyHist1DProjector</a>, <a class="el" href="classhippodraw_1_1DyHist2DProjector.html#af844b7651dc35543e5b0904e3153db16">DyHist2DProjector</a>, <a class="el" href="classhippodraw_1_1NTupleProjector.html#a5380948822be75c060ae8cc538cd1327">NTupleProjector</a>, <a class="el" href="classhippodraw_1_1Profile2DProjector.html#af844b7651dc35543e5b0904e3153db16">Profile2DProjector</a>, <a class="el" href="classhippodraw_1_1ProfileProjector.html#af844b7651dc35543e5b0904e3153db16">ProfileProjector</a>, and <a class="el" href="classhippodraw_1_1RootController.html#adefbc387148a9902e36e5768871713ce">RootController</a>.</p> <p>Definition at line <a class="el" href="Observer_8cxx_source.html#l00025">25</a> of file <a class="el" href="Observer_8cxx_source.html">Observer.cxx</a>.</p> <p>Referenced by <a class="el" href="DataRep_8cxx_source.html#l00058">DataRep::~DataRep()</a>, <a class="el" href="DataSource_8cxx_source.html#l00107">DataSource::~DataSource()</a>, <a class="el" href="NTuple_8cxx_source.html#l00123">NTuple::~NTuple()</a>, <a class="el" href="PlotterBase_8cxx_source.html#l00078">PlotterBase::~PlotterBase()</a>, <a class="el" href="RootNTuple_8cxx_source.html#l00063">RootNTuple::~RootNTuple()</a>, and <a class="el" href="RTuple_8cxx_source.html#l00066">RTuple::~RTuple()</a>.</p> </div> </div> <hr/><h2>Member Data Documentation</h2> <a class="anchor" id="a931e04f416b41144ed7eab6cb9326d2a"></a><!-- doxytag: member="hippodraw::ObserverWrap::m_self" ref="a931e04f416b41144ed7eab6cb9326d2a" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">PyObject* <a class="el" href="classhippodraw_1_1ObserverWrap.html#a931e04f416b41144ed7eab6cb9326d2a">m_self</a><code> [private]</code></td> </tr> </table> </div> <div class="memdoc"> <p>The held <a class="el" href="namespacehippodraw_1_1Python.html" title="A namespace encapsulating functions to interface HippoDraw classes to Python using...">Python</a> object. </p> <p>Definition at line <a class="el" href="ObserverWrap_8h_source.html#l00036">36</a> of file <a class="el" href="ObserverWrap_8h_source.html">ObserverWrap.h</a>.</p> </div> </div> <hr/>The documentation for this class was generated from the following files:<ul> <li><a class="el" href="ObserverWrap_8h_source.html">ObserverWrap.h</a></li> <li><a class="el" href="ObserverWrap_8cxx_source.html">ObserverWrap.cxx</a></li> </ul> </div> <hr size="1"><address style="align: right;"><small> Generated for HippoDraw Class Library by <a href="http://www.doxygen.org/index.html"> <img src="doxygen.png" alt="doxygen" align="middle" border=0> </a> </small></address> </body> </html>