<!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: dtn::APIEndpointIDOpt 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="namespacedtn.html">dtn</a>::<a class="el" href="classdtn_1_1APIEndpointIDOpt.html">APIEndpointIDOpt</a>
</div>
</div>
<div class="contents">
<h1>dtn::APIEndpointIDOpt Class Reference</h1><!-- doxytag: class="dtn::APIEndpointIDOpt" --><code>#include <<a class="el" href="APIEndpointIDOpt_8h-source.html">APIEndpointIDOpt.h</a>></code>
<p>
<p>
<a href="classdtn_1_1APIEndpointIDOpt-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Extension class to the <a class="el" href="namespaceoasys.html">oasys</a> Opt hierarchy that validates that the option is a DTN endpoint identifier (i.e.
<p>
a URI).
<p>Definition at line <a class="el" href="APIEndpointIDOpt_8h-source.html#l00032">32</a> of file <a class="el" href="APIEndpointIDOpt_8h-source.html">APIEndpointIDOpt.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="classdtn_1_1APIEndpointIDOpt.html#b21df72f86e7a01d92e775cc27cc9466">APIEndpointIDOpt</a> (const char *opt, <a class="el" href="structdtn__endpoint__id__t.html">dtn_endpoint_id_t</a> *valp, const char *valdesc="", const char *desc="", <a class="el" href="serialsource_8c.html#1062901a7428fdd9c7f180f5e01ea056">bool</a> *setp=NULL)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Basic constructor. <a href="#b21df72f86e7a01d92e775cc27cc9466"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtn_1_1APIEndpointIDOpt.html#e9f42350ad654234265868b07a47e47a">APIEndpointIDOpt</a> (char shortopt, const char *longopt, <a class="el" href="structdtn__endpoint__id__t.html">dtn_endpoint_id_t</a> *valp, const char *valdesc="", const char *desc="", <a class="el" href="serialsource_8c.html#1062901a7428fdd9c7f180f5e01ea056">bool</a> *setp=NULL)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Alternative constructor with both short and long options, suitable for getopt calls. <a href="#e9f42350ad654234265868b07a47e47a"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtn_1_1APIEndpointIDOpt.html#41956b8f4e8d9f306f85de3c3b02eb0c">set</a> (const char *<a class="el" href="num2sdnv_8c.html#455b3605dc605fe8e055b9c1470535cf">val</a>, size_t len)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtn_1_1APIEndpointIDOpt.html#a978eda387e7b615c0f403fc05a5b109">get</a> (oasys::StringBuffer *<a class="el" href="num2sdnv_8c.html#a81cdcc7ff6987bc85c073253e32715f">buf</a>)</td></tr>
</table>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="b21df72f86e7a01d92e775cc27cc9466"></a><!-- doxytag: member="dtn::APIEndpointIDOpt::APIEndpointIDOpt" ref="b21df72f86e7a01d92e775cc27cc9466" args="(const char *opt, dtn_endpoint_id_t *valp, const char *valdesc="", const char *desc="", bool *setp=NULL)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">dtn::APIEndpointIDOpt::APIEndpointIDOpt </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>opt</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structdtn__endpoint__id__t.html">dtn_endpoint_id_t</a> * </td>
<td class="paramname"> <em>valp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>valdesc</em> = <code>""</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>desc</em> = <code>""</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="serialsource_8c.html#1062901a7428fdd9c7f180f5e01ea056">bool</a> * </td>
<td class="paramname"> <em>setp</em> = <code>NULL</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Basic constructor.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>opt</em> </td><td>the option string </td></tr>
<tr><td valign="top"></td><td valign="top"><em>valp</em> </td><td>pointer to the value </td></tr>
<tr><td valign="top"></td><td valign="top"><em>valdesc</em> </td><td>short description for the value </td></tr>
<tr><td valign="top"></td><td valign="top"><em>desc</em> </td><td>descriptive string </td></tr>
<tr><td valign="top"></td><td valign="top"><em>setp</em> </td><td>optional pointer to indicate whether or not the option was set </td></tr>
</table>
</dl>
<p>Definition at line <a class="el" href="APIEndpointIDOpt_8cc-source.html#l00027">27</a> of file <a class="el" href="APIEndpointIDOpt_8cc-source.html">APIEndpointIDOpt.cc</a>.</p>
</div>
</div><p>
<a class="anchor" name="e9f42350ad654234265868b07a47e47a"></a><!-- doxytag: member="dtn::APIEndpointIDOpt::APIEndpointIDOpt" ref="e9f42350ad654234265868b07a47e47a" args="(char shortopt, const char *longopt, dtn_endpoint_id_t *valp, const char *valdesc="", const char *desc="", bool *setp=NULL)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">dtn::APIEndpointIDOpt::APIEndpointIDOpt </td>
<td>(</td>
<td class="paramtype">char </td>
<td class="paramname"> <em>shortopt</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>longopt</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structdtn__endpoint__id__t.html">dtn_endpoint_id_t</a> * </td>
<td class="paramname"> <em>valp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>valdesc</em> = <code>""</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>desc</em> = <code>""</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="serialsource_8c.html#1062901a7428fdd9c7f180f5e01ea056">bool</a> * </td>
<td class="paramname"> <em>setp</em> = <code>NULL</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Alternative constructor with both short and long options, suitable for getopt calls.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>shortopt</em> </td><td>short option character </td></tr>
<tr><td valign="top"></td><td valign="top"><em>longopt</em> </td><td>long option string </td></tr>
<tr><td valign="top"></td><td valign="top"><em>valp</em> </td><td>pointer to the value </td></tr>
<tr><td valign="top"></td><td valign="top"><em>valdesc</em> </td><td>short description for the value </td></tr>
<tr><td valign="top"></td><td valign="top"><em>desc</em> </td><td>descriptive string </td></tr>
<tr><td valign="top"></td><td valign="top"><em>setp</em> </td><td>optional pointer to indicate whether or not the option was set </td></tr>
</table>
</dl>
<p>Definition at line <a class="el" href="APIEndpointIDOpt_8cc-source.html#l00034">34</a> of file <a class="el" href="APIEndpointIDOpt_8cc-source.html">APIEndpointIDOpt.cc</a>.</p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="41956b8f4e8d9f306f85de3c3b02eb0c"></a><!-- doxytag: member="dtn::APIEndpointIDOpt::set" ref="41956b8f4e8d9f306f85de3c3b02eb0c" args="(const char *val, size_t len)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int dtn::APIEndpointIDOpt::set </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>val</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>len</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Definition at line <a class="el" href="APIEndpointIDOpt_8cc-source.html#l00043">43</a> of file <a class="el" href="APIEndpointIDOpt_8cc-source.html">APIEndpointIDOpt.cc</a>.</p>
<p>References <a class="el" href="num2sdnv_8c-source.html#l00035">buf</a>, <a class="el" href="dtn__types_8h-source.html#l00047">DTN_MAX_ENDPOINT_ID</a>, and <a class="el" href="dtn__api_8c-source.html#l00681">dtn_parse_eid_string()</a>.</p>
</div>
</div><p>
<a class="anchor" name="a978eda387e7b615c0f403fc05a5b109"></a><!-- doxytag: member="dtn::APIEndpointIDOpt::get" ref="a978eda387e7b615c0f403fc05a5b109" args="(oasys::StringBuffer *buf)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void dtn::APIEndpointIDOpt::get </td>
<td>(</td>
<td class="paramtype">oasys::StringBuffer * </td>
<td class="paramname"> <em>buf</em> </td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Definition at line <a class="el" href="APIEndpointIDOpt_8cc-source.html#l00065">65</a> of file <a class="el" href="APIEndpointIDOpt_8cc-source.html">APIEndpointIDOpt.cc</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="APIEndpointIDOpt_8h-source.html">APIEndpointIDOpt.h</a><li><a class="el" href="APIEndpointIDOpt_8cc-source.html">APIEndpointIDOpt.cc</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jul 21 14:09:50 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>
