<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>DTN Reference Implementation: dtnsim::SimEvent Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.6 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="main.html"><span>Main Page</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>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</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="namespacedtnsim.html">dtnsim</a>::<a class="el" href="classdtnsim_1_1SimEvent.html">SimEvent</a>
</div>
</div>
<div class="contents">
<h1>dtnsim::SimEvent Class Reference</h1><!-- doxytag: class="dtnsim::SimEvent" --><code>#include <<a class="el" href="SimEvent_8h-source.html">SimEvent.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for dtnsim::SimEvent:</div>
<div class="dynsection">
<p><center><img src="classdtnsim_1_1SimEvent.png" usemap="#dtnsim::SimEvent_map" border="0" alt=""></center>
<map name="dtnsim::SimEvent_map">
<area href="classdtnsim_1_1SimAtEvent.html" alt="dtnsim::SimAtEvent" shape="rect" coords="0,56,144,80">
<area href="classdtnsim_1_1SimBundleEvent.html" alt="dtnsim::SimBundleEvent" shape="rect" coords="154,56,298,80">
</map>
</div>
<p>
<a href="classdtnsim_1_1SimEvent-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
<p>Definition at line <a class="el" href="SimEvent_8h-source.html#l00054">54</a> of file <a class="el" href="SimEvent_8h-source.html">SimEvent.h</a>.</p>
<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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtnsim_1_1SimEvent.html#27541989fea54f445f29c4e2d8d4e6c0">SimEvent</a> (<a class="el" href="namespacedtnsim.html#61b536ebb250b12bfe00104b1f33ef4d">sim_event_type_t</a> type, double time, <a class="el" href="classdtnsim_1_1SimEventHandler.html">SimEventHandler</a> *handler)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#27541989fea54f445f29c4e2d8d4e6c0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classdtnsim_1_1SimEventHandler.html">SimEventHandler</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtnsim_1_1SimEvent.html#3c499eef78bee8a1d3fbc5cf8df86ae4">handler</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtnsim_1_1SimEvent.html#7fac75dd67b59a8d40673700f1357dc8">time</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="serialsource_8c.html#1062901a7428fdd9c7f180f5e01ea056">bool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtnsim_1_1SimEvent.html#ac66a522af3b0b5f83fa9e5a2bf86755">is_valid</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="namespacedtnsim.html#61b536ebb250b12bfe00104b1f33ef4d">sim_event_type_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtnsim_1_1SimEvent.html#bce459b06f5ab4673ed662e7d4aec1ad">type</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtnsim_1_1SimEvent.html#f4af98be7e81c4d574ac1c3f40304fcb">type_str</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtnsim_1_1SimEvent.html#b02bdbf19826f41c07375cbf02b6aaae">cancel</a> ()</td></tr>
<tr><td colspan="2"><br><h2>Private Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="namespacedtnsim.html#61b536ebb250b12bfe00104b1f33ef4d">sim_event_type_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtnsim_1_1SimEvent.html#7bd04aa8ca6410ba01e886b4f89dd00a">type_</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Type of the event. <a href="#7bd04aa8ca6410ba01e886b4f89dd00a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtnsim_1_1SimEvent.html#56c16b582725770855016cbe8f12fd77">time_</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Time when the event will fire. <a href="#56c16b582725770855016cbe8f12fd77"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classdtnsim_1_1SimEventHandler.html">SimEventHandler</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtnsim_1_1SimEvent.html#b9aad1dd8dd9b1adfc2891ea713c9d02">handler_</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Handler that will process the event. <a href="#b9aad1dd8dd9b1adfc2891ea713c9d02"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="serialsource_8c.html#1062901a7428fdd9c7f180f5e01ea056">bool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtnsim_1_1SimEvent.html#ba93908118116edc56bc244c9ad10df7">valid_</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Indicator if the event was cancelled. <a href="#ba93908118116edc56bc244c9ad10df7"></a><br></td></tr>
</table>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="27541989fea54f445f29c4e2d8d4e6c0"></a><!-- doxytag: member="dtnsim::SimEvent::SimEvent" ref="27541989fea54f445f29c4e2d8d4e6c0" args="(sim_event_type_t type, double time, SimEventHandler *handler)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">dtnsim::SimEvent::SimEvent </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespacedtnsim.html#61b536ebb250b12bfe00104b1f33ef4d">sim_event_type_t</a> </td>
<td class="paramname"> <em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"> <em>time</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classdtnsim_1_1SimEventHandler.html">SimEventHandler</a> * </td>
<td class="paramname"> <em>handler</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constructor.
<p>
<p>Definition at line <a class="el" href="SimEvent_8h-source.html#l00059">59</a> of file <a class="el" href="SimEvent_8h-source.html">SimEvent.h</a>.</p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="3c499eef78bee8a1d3fbc5cf8df86ae4"></a><!-- doxytag: member="dtnsim::SimEvent::handler" ref="3c499eef78bee8a1d3fbc5cf8df86ae4" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classdtnsim_1_1SimEventHandler.html">SimEventHandler</a>* dtnsim::SimEvent::handler </td>
<td>(</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="SimEvent_8h-source.html#l00062">62</a> of file <a class="el" href="SimEvent_8h-source.html">SimEvent.h</a>.</p>
<p>References <a class="el" href="SimEvent_8h-source.html#l00073">handler_</a>.</p>
<p>Referenced by <a class="el" href="Simulator_8cc-source.html#l00131">dtnsim::Simulator::run()</a>.</p>
</div>
</div><p>
<a class="anchor" name="7fac75dd67b59a8d40673700f1357dc8"></a><!-- doxytag: member="dtnsim::SimEvent::time" ref="7fac75dd67b59a8d40673700f1357dc8" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double dtnsim::SimEvent::time </td>
<td>(</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="SimEvent_8h-source.html#l00063">63</a> of file <a class="el" href="SimEvent_8h-source.html">SimEvent.h</a>.</p>
<p>References <a class="el" href="SimEvent_8h-source.html#l00072">time_</a>.</p>
<p>Referenced by <a class="el" href="SimEvent_8h-source.html#l00085">dtnsim::SimEventCompare::operator()()</a>, and <a class="el" href="Simulator_8cc-source.html#l00131">dtnsim::Simulator::run()</a>.</p>
</div>
</div><p>
<a class="anchor" name="ac66a522af3b0b5f83fa9e5a2bf86755"></a><!-- doxytag: member="dtnsim::SimEvent::is_valid" ref="ac66a522af3b0b5f83fa9e5a2bf86755" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="serialsource_8c.html#1062901a7428fdd9c7f180f5e01ea056">bool</a> dtnsim::SimEvent::is_valid </td>
<td>(</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="SimEvent_8h-source.html#l00064">64</a> of file <a class="el" href="SimEvent_8h-source.html">SimEvent.h</a>.</p>
<p>References <a class="el" href="SimEvent_8h-source.html#l00074">valid_</a>.</p>
<p>Referenced by <a class="el" href="Simulator_8cc-source.html#l00131">dtnsim::Simulator::run()</a>.</p>
</div>
</div><p>
<a class="anchor" name="bce459b06f5ab4673ed662e7d4aec1ad"></a><!-- doxytag: member="dtnsim::SimEvent::type" ref="bce459b06f5ab4673ed662e7d4aec1ad" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespacedtnsim.html#61b536ebb250b12bfe00104b1f33ef4d">sim_event_type_t</a> dtnsim::SimEvent::type </td>
<td>(</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="SimEvent_8h-source.html#l00065">65</a> of file <a class="el" href="SimEvent_8h-source.html">SimEvent.h</a>.</p>
<p>References <a class="el" href="SimEvent_8h-source.html#l00071">type_</a>.</p>
<p>Referenced by <a class="el" href="Simulator_8cc-source.html#l00286">dtnsim::Simulator::process()</a>, and <a class="el" href="sim_2Node_8cc-source.html#l00169">dtnsim::Node::process()</a>.</p>
</div>
</div><p>
<a class="anchor" name="f4af98be7e81c4d574ac1c3f40304fcb"></a><!-- doxytag: member="dtnsim::SimEvent::type_str" ref="f4af98be7e81c4d574ac1c3f40304fcb" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* dtnsim::SimEvent::type_str </td>
<td>(</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="SimEvent_8h-source.html#l00066">66</a> of file <a class="el" href="SimEvent_8h-source.html">SimEvent.h</a>.</p>
<p>References <a class="el" href="SimEvent_8h-source.html#l00042">dtnsim::sim_ev2str()</a>, and <a class="el" href="SimEvent_8h-source.html#l00071">type_</a>.</p>
<p>Referenced by <a class="el" href="Simulator_8cc-source.html#l00131">dtnsim::Simulator::run()</a>.</p>
</div>
</div><p>
<a class="anchor" name="b02bdbf19826f41c07375cbf02b6aaae"></a><!-- doxytag: member="dtnsim::SimEvent::cancel" ref="b02bdbf19826f41c07375cbf02b6aaae" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void dtnsim::SimEvent::cancel </td>
<td>(</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="SimEvent_8h-source.html#l00068">68</a> of file <a class="el" href="SimEvent_8h-source.html">SimEvent.h</a>.</p>
<p>References <a class="el" href="SimEvent_8h-source.html#l00074">valid_</a>.</p>
</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="7bd04aa8ca6410ba01e886b4f89dd00a"></a><!-- doxytag: member="dtnsim::SimEvent::type_" ref="7bd04aa8ca6410ba01e886b4f89dd00a" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespacedtnsim.html#61b536ebb250b12bfe00104b1f33ef4d">sim_event_type_t</a> <a class="el" href="classdtnsim_1_1SimEvent.html#7bd04aa8ca6410ba01e886b4f89dd00a">dtnsim::SimEvent::type_</a><code> [private]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Type of the event.
<p>
<p>Definition at line <a class="el" href="SimEvent_8h-source.html#l00071">71</a> of file <a class="el" href="SimEvent_8h-source.html">SimEvent.h</a>.</p>
<p>Referenced by <a class="el" href="SimEvent_8h-source.html#l00065">type()</a>, and <a class="el" href="SimEvent_8h-source.html#l00066">type_str()</a>.</p>
</div>
</div><p>
<a class="anchor" name="56c16b582725770855016cbe8f12fd77"></a><!-- doxytag: member="dtnsim::SimEvent::time_" ref="56c16b582725770855016cbe8f12fd77" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double <a class="el" href="classdtnsim_1_1SimEvent.html#56c16b582725770855016cbe8f12fd77">dtnsim::SimEvent::time_</a><code> [private]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Time when the event will fire.
<p>
<p>Definition at line <a class="el" href="SimEvent_8h-source.html#l00072">72</a> of file <a class="el" href="SimEvent_8h-source.html">SimEvent.h</a>.</p>
<p>Referenced by <a class="el" href="SimEvent_8h-source.html#l00063">time()</a>.</p>
</div>
</div><p>
<a class="anchor" name="b9aad1dd8dd9b1adfc2891ea713c9d02"></a><!-- doxytag: member="dtnsim::SimEvent::handler_" ref="b9aad1dd8dd9b1adfc2891ea713c9d02" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classdtnsim_1_1SimEventHandler.html">SimEventHandler</a>* <a class="el" href="classdtnsim_1_1SimEvent.html#b9aad1dd8dd9b1adfc2891ea713c9d02">dtnsim::SimEvent::handler_</a><code> [private]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Handler that will process the event.
<p>
<p>Definition at line <a class="el" href="SimEvent_8h-source.html#l00073">73</a> of file <a class="el" href="SimEvent_8h-source.html">SimEvent.h</a>.</p>
<p>Referenced by <a class="el" href="SimEvent_8h-source.html#l00062">handler()</a>.</p>
</div>
</div><p>
<a class="anchor" name="ba93908118116edc56bc244c9ad10df7"></a><!-- doxytag: member="dtnsim::SimEvent::valid_" ref="ba93908118116edc56bc244c9ad10df7" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="serialsource_8c.html#1062901a7428fdd9c7f180f5e01ea056">bool</a> <a class="el" href="classdtnsim_1_1SimEvent.html#ba93908118116edc56bc244c9ad10df7">dtnsim::SimEvent::valid_</a><code> [private]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Indicator if the event was cancelled.
<p>
<p>Definition at line <a class="el" href="SimEvent_8h-source.html#l00074">74</a> of file <a class="el" href="SimEvent_8h-source.html">SimEvent.h</a>.</p>
<p>Referenced by <a class="el" href="SimEvent_8h-source.html#l00068">cancel()</a>, and <a class="el" href="SimEvent_8h-source.html#l00064">is_valid()</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="SimEvent_8h-source.html">SimEvent.h</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jul 21 14:09:55 2008 for DTN Reference Implementation by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
</body>
</html>
