<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>libsmbios_c library: smbios::IToken Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul class="tablist">
<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>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
<div class="navpath">
<ul>
<li><a class="el" href="namespacesmbios.html">smbios</a> </li>
<li><a class="el" href="classsmbios_1_1IToken.html">smbios::IToken</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> </div>
<div class="headertitle">
<h1>smbios::IToken Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="smbios::IToken" -->
<p>Interface to inspect or manipulate individual tokens.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="IToken_8h_source.html">IToken.h</a>></code></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classsmbios_1_1IToken.html#a9975c19e986203cd604cc299388d5c63">~IToken</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classsmbios_1_1IToken.html#a8a6109ecd18914a93c93281dfa91b580">getTokenClass</a> () const =0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="types_8h.html#a10e94b422ef0c20dcdec20d31a1f5049">u32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsmbios_1_1IToken.html#a1bbe34b3d9f859435f8d69280a7b1d4a">getType</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the Token Type, per Dell SMBIOS Spec. <a href="#a1bbe34b3d9f859435f8d69280a7b1d4a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classsmbios_1_1IToken.html#a5a439fc1c5754d38c1fbd2afb73093f5">isActive</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns true if bitfield-type token is set. <a href="#a5a439fc1c5754d38c1fbd2afb73093f5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsmbios_1_1IToken.html#ae143344e1245a0751242c4584865ee59">activate</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the bitmask for bitfield-type tokens. <a href="#ae143344e1245a0751242c4584865ee59"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classsmbios_1_1IToken.html#aab0dbd7bad8b4e24caf2cc4a6201b11c">isString</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns true for string-type tokens. <a href="#aab0dbd7bad8b4e24caf2cc4a6201b11c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classsmbios_1_1IToken.html#a8d296d5104d85be362cbf8ab9bf392b7">isBool</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns true for bool-type tokens. <a href="#a8d296d5104d85be362cbf8ab9bf392b7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classsmbios_1_1IToken.html#a6dbbdb966974d472a282e0dc80f8e282">getStringLength</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns length for string-type tokens. <a href="#a6dbbdb966974d472a282e0dc80f8e282"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual const std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classsmbios_1_1IToken.html#a59c29ccc4e21bc467bdcef1526aa89cf">getString</a> (<a class="el" href="types_8h.html#aed742c436da53c1080638ce6ef7d13de">u8</a> *byteArray=0, unsigned int size=0) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">returns std:string and raw value in first parameter. <a href="#a59c29ccc4e21bc467bdcef1526aa89cf"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsmbios_1_1IToken.html#af398672775574601e78f07fdd77b3948">setString</a> (const <a class="el" href="types_8h.html#aed742c436da53c1080638ce6ef7d13de">u8</a> *byteArray, size_t size) const =0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual const <a class="el" href="classsmbios_1_1ISmbiosItem.html">ISmbiosItem</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classsmbios_1_1IToken.html#ae2ce73f8bba7c99a8254d094cb922eaf">getItemRef</a> () const =0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual std::ostream & </td><td class="memItemRight" valign="bottom"><a class="el" href="classsmbios_1_1IToken.html#ae10b61951e58fefafd5dfa22b6167eb1">streamify</a> (std::ostream &cout) const =0</td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsmbios_1_1IToken.html#a04d7770ec06b1d71b392f79a31c648be">IToken</a> ()</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Interface to inspect or manipulate individual tokens. </p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a9975c19e986203cd604cc299388d5c63"></a><!-- doxytag: member="smbios::IToken::~IToken" ref="a9975c19e986203cd604cc299388d5c63" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual smbios::IToken::~IToken </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a04d7770ec06b1d71b392f79a31c648be"></a><!-- doxytag: member="smbios::IToken::IToken" ref="a04d7770ec06b1d71b392f79a31c648be" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">smbios::IToken::IToken </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ae143344e1245a0751242c4584865ee59"></a><!-- doxytag: member="smbios::IToken::activate" ref="ae143344e1245a0751242c4584865ee59" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void smbios::IToken::activate </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the bitmask for bitfield-type tokens. </p>
</div>
</div>
<a class="anchor" id="ae2ce73f8bba7c99a8254d094cb922eaf"></a><!-- doxytag: member="smbios::IToken::getItemRef" ref="ae2ce73f8bba7c99a8254d094cb922eaf" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const <a class="el" href="classsmbios_1_1ISmbiosItem.html">ISmbiosItem</a>& smbios::IToken::getItemRef </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a59c29ccc4e21bc467bdcef1526aa89cf"></a><!-- doxytag: member="smbios::IToken::getString" ref="a59c29ccc4e21bc467bdcef1526aa89cf" args="(u8 *byteArray=0, unsigned int size=0) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const std::string smbios::IToken::getString </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#aed742c436da53c1080638ce6ef7d13de">u8</a> * </td>
<td class="paramname"> <em>byteArray</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>size</em> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>returns std:string and raw value in first parameter. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>byteArray</em> </td><td>If Non-NULL, <a class="el" href="classsmbios_1_1IToken.html#a59c29ccc4e21bc467bdcef1526aa89cf" title="returns std:string and raw value in first parameter.">getString()</a> will store the raw string here. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>This must be the length of the space allocated for byteArray. <a class="el" href="classsmbios_1_1IToken.html#a59c29ccc4e21bc467bdcef1526aa89cf" title="returns std:string and raw value in first parameter.">getString()</a> will not overflow this length. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Returns a C++-style std::string initialized with the contents of byteArray. Only useful for strings that hold C-style zero-terminated strings. </dd></dl>
</div>
</div>
<a class="anchor" id="a6dbbdb966974d472a282e0dc80f8e282"></a><!-- doxytag: member="smbios::IToken::getStringLength" ref="a6dbbdb966974d472a282e0dc80f8e282" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual unsigned int smbios::IToken::getStringLength </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns length for string-type tokens. </p>
</div>
</div>
<a class="anchor" id="a8a6109ecd18914a93c93281dfa91b580"></a><!-- doxytag: member="smbios::IToken::getTokenClass" ref="a8a6109ecd18914a93c93281dfa91b580" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual std::string smbios::IToken::getTokenClass </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a1bbe34b3d9f859435f8d69280a7b1d4a"></a><!-- doxytag: member="smbios::IToken::getType" ref="a1bbe34b3d9f859435f8d69280a7b1d4a" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="types_8h.html#a10e94b422ef0c20dcdec20d31a1f5049">u32</a> smbios::IToken::getType </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the Token Type, per Dell SMBIOS Spec. </p>
</div>
</div>
<a class="anchor" id="a5a439fc1c5754d38c1fbd2afb73093f5"></a><!-- doxytag: member="smbios::IToken::isActive" ref="a5a439fc1c5754d38c1fbd2afb73093f5" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool smbios::IToken::isActive </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns true if bitfield-type token is set. </p>
</div>
</div>
<a class="anchor" id="a8d296d5104d85be362cbf8ab9bf392b7"></a><!-- doxytag: member="smbios::IToken::isBool" ref="a8d296d5104d85be362cbf8ab9bf392b7" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool smbios::IToken::isBool </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns true for bool-type tokens. </p>
</div>
</div>
<a class="anchor" id="aab0dbd7bad8b4e24caf2cc4a6201b11c"></a><!-- doxytag: member="smbios::IToken::isString" ref="aab0dbd7bad8b4e24caf2cc4a6201b11c" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool smbios::IToken::isString </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns true for string-type tokens. </p>
</div>
</div>
<a class="anchor" id="af398672775574601e78f07fdd77b3948"></a><!-- doxytag: member="smbios::IToken::setString" ref="af398672775574601e78f07fdd77b3948" args="(const u8 *byteArray, size_t size) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void smbios::IToken::setString </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="types_8h.html#aed742c436da53c1080638ce6ef7d13de">u8</a> * </td>
<td class="paramname"> <em>byteArray</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>size</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ae10b61951e58fefafd5dfa22b6167eb1"></a><!-- doxytag: member="smbios::IToken::streamify" ref="ae10b61951e58fefafd5dfa22b6167eb1" args="(std::ostream &cout) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual std::ostream& smbios::IToken::streamify </td>
<td>(</td>
<td class="paramtype">std::ostream & </td>
<td class="paramname"> <em>cout</em></td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>/builddir/build/BUILD/libsmbios-2.2.26/src/include/smbios/<a class="el" href="IToken_8h_source.html">IToken.h</a></li>
</ul>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Tue Oct 5 2010 for libsmbios_c library by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address>
</body>
</html>
