ejson/class_ejson__Number.html
2014-10-18 09:19:59 +02:00

164 lines
10 KiB
HTML

<!DOCTYPE html>
<html>
<head>
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
<title>ejson Library</title>
<link rel="stylesheet" href="base.css">
<link rel="stylesheet" href="menu.css">
</head>
<body>
<div class="navbar navbar-fixed-top">
<div class="container">
<h1><a href="index.html">ejson library</a></h1>
<h4><a href="http://github.com/heeroyui/ejson/">&nbsp;&nbsp;&nbsp;[ sources ]</a></h4>
<h3>API:</h3> <div id="menu">
<ul class="niveau1">
<li><a href="namespace_ejson.html">ejson</a>
</li>
</ul>
</div>
<h3>Tutorials:</h3><div id="menu">
<ul class="niveau1"><li><a href="tutorial_000_Build.html">Build</a></li>
</ul><ul class="niveau1"><li><a href="tutorial_001_Read.html">Read</a></li>
</ul><ul class="niveau1"><li><a href="tutorial_002_Write.html">Write</a></li>
</ul></div>
<br/><h3>Associate libraries:</h3><div id="menu">
<ul class="niveau1"><li><a href="../ewol/index.html">ewol</a></li>
</ul><ul class="niveau1"><li><a href="../egami/index.html">egami</a></li>
</ul><ul class="niveau1"><li><a href="../ege/index.html">ege</a></li>
</ul><ul class="niveau1"><li><a href="../esvg/index.html">esvg</a></li>
</ul><ul class="niveau1"><li><a href="../etk/index.html">etk</a></li>
</ul><ul class="niveau1"><li><a href="../exml/index.html">exml</a></li>
</ul></div>
<br/>
<br/>
<br/>
<br/>
<br/>
<br/>
</div>
</div>
<div class="container" id="content">
<h1>class: ejson::Number</h1><hr/><h2>Description:</h2>
<br/><br/>
<h2>Constructor and Destructor:</h2>
<pre>
+ <a class="code-function" href="#4079">Number</a> (<span class="code-type" >double</span> <span class="code-argument">_value</span>);<br/>+ <span class="code-storage-keyword">virtual</span> <a class="code-function" href="#4081">~Number</a> ();<br/></pre>
<br/>
<h2>Synopsis:</h2>
<pre>
# <span class="code-type" >double</span> <a class="code-member" href="#4082">m_value</a>;<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#4083">set</a> (<span class="code-type" >double</span> <span class="code-argument">_value</span>);<br/>+ <span class="code-type" >double</span> <a class="code-function" href="#4085">get</a> () <span class="code-storage-keyword">const</span>;<br/>+ <span class="code-type" >int32_t</span> <a class="code-function" href="#4086">getInt32</a> () <span class="code-storage-keyword">const</span>;<br/>+ <span class="code-type" >int64_t</span> <a class="code-function" href="#4087">getInt64</a> () <span class="code-storage-keyword">const</span>;<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >bool</span> <a class="code-function" href="#4088">iParse</a> (<span class="code-storage-keyword">const</span> <a class="code-type" href="http://www.cplusplus.com/reference/string/string/">std::string</a> & <span class="code-argument">_data</span>,<br/> size_t & <span class="code-argument">_pos</span>,<br/> <a class="code-type" href="class_ejson__filePos.html">ejson::filePos</a> & <span class="code-argument">_filePos</span>,<br/> <a class="code-type" href="class_ejson__Document.html">ejson::Document</a> & <span class="code-argument">_doc</span>);<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >bool</span> <a class="code-function" href="#4093">iGenerate</a> (<a class="code-type" href="http://www.cplusplus.com/reference/string/string/">std::string</a> & <span class="code-argument">_data</span>,<br/> size_t <span class="code-argument">_indent</span>) <span class="code-storage-keyword">const</span>;<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >bool</span> <a class="code-function" href="#4096">transfertIn</a> (<a class="code-type" href="class_ejson__Value.html">ejson::Value</a>* <span class="code-argument">_obj</span>);<br/>+ <span class="code-storage-keyword">virtual</span> <a class="code-type" href="class_ejson__Value.html">ejson::Value</a>* <a class="code-function" href="#4098">duplicate</a> () <span class="code-storage-keyword">const</span>;<br/></pre>
<br/>
<h2>Object Hierarchy:<h2>
<pre>
+<a href="class_ejson__Value.html">ejson::Value</a><br/> +--> ejson::Number<br/></pre>
<h2>Detail:</h2>
<a id="4079"/><a id="4081"/><h3>Number</h3><pre>
+ <span class="code-function">Number</span> (<span class="code-type" >double</span> <span class="code-argument">_value</span>);<br/></pre>
basic element of a xml structure<br/>
<br/>
<hr/>
<a id="4082"/><h3>~Number</h3><pre>
+ <span class="code-storage-keyword">virtual</span> <span class="code-function">~Number</span> ();<br/></pre>
destructor<br/>
<br/>
<hr/>
<a id="4083"/><h3>m_value</h3><pre>
# <span class="code-type" >double</span> <span class="code-member">m_value</span>;<br/></pre>
value of the node<br/>
<br/>
<hr/>
<a id="4085"/><h3>set</h3><pre>
+ <span class="code-type" >void</span> <span class="code-function">set</span> (<span class="code-type" >double</span> <span class="code-argument">_value</span>);<br/></pre>
set the value of the node.<br/><ul>
<table class="parameter-list">
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_value</span> </td><td> New value of the node.</td></tr>
</table>
</ul>
<br/>
<hr/>
<a id="4086"/><h3>get</h3><pre>
+ <span class="code-type" >double</span> <span class="code-function">get</span> () <span class="code-storage-keyword">const</span>;<br/></pre>
Get the current element Value.<br/><ul>
<table class="parameter-list">
<tr><td><b>Return: </b></td><td></td><td>The double number registered</td></tr></table>
</ul>
<br/>
<hr/>
<a id="4087"/><h3>getInt32</h3><pre>
+ <span class="code-type" >int32_t</span> <span class="code-function">getInt32</span> () <span class="code-storage-keyword">const</span>;<br/></pre>
Get the current element Value.<br/><ul>
<table class="parameter-list">
<tr><td><b>Return: </b></td><td></td><td>The 32 bit integer number registered</td></tr></table>
</ul>
<br/>
<hr/>
<a id="4088"/><h3>getInt64</h3><pre>
+ <span class="code-type" >int64_t</span> <span class="code-function">getInt64</span> () <span class="code-storage-keyword">const</span>;<br/></pre>
Get the current element Value.<br/><ul>
<table class="parameter-list">
<tr><td><b>Return: </b></td><td></td><td>The 64 bit integer number registered</td></tr></table>
</ul>
<br/>
<hr/>
<a id="4093"/><h3>iParse</h3><pre>
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >bool</span> <span class="code-function">iParse</span> (<span class="code-storage-keyword">const</span> <a class="code-type" href="http://www.cplusplus.com/reference/string/string/">std::string</a> & <span class="code-argument">_data</span>,<br/> size_t & <span class="code-argument">_pos</span>,<br/> <a class="code-type" href="class_ejson__filePos.html">ejson::filePos</a> & <span class="code-argument">_filePos</span>,<br/> <a class="code-type" href="class_ejson__Document.html">ejson::Document</a> & <span class="code-argument">_doc</span>);<br/></pre>
parse the Current node [pure VIRUAL]<br/><ul>
<table class="parameter-list">
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_data</span> </td><td> data string to parse.</td></tr>
<td><b>Parameter [input] [output]:</b></td><td><span class="code-argument">_pos</span> </td><td> position in the string to start parse, return the position end of parsing.</td></tr>
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_caseSensitive</span> </td><td> Request a parsion of element that is not case sensitive (all element is in low case)</td></tr>
<td><b>Parameter [input] [output]:</b></td><td><span class="code-argument">file</span> </td><td> parsing position (line x col x)</td></tr>
<tr><td><b>Return: </b></td><td></td><td>false if an error occured.</td></tr></table>
</ul>
<br/>
<hr/>
<a id="4096"/><h3>iGenerate</h3><pre>
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >bool</span> <span class="code-function">iGenerate</span> (<a class="code-type" href="http://www.cplusplus.com/reference/string/string/">std::string</a> & <span class="code-argument">_data</span>,<br/> size_t <span class="code-argument">_indent</span>) <span class="code-storage-keyword">const</span>;<br/></pre>
generate a string with the tree of the xml<br/><ul>
<table class="parameter-list">
<td><b>Parameter [input] [output]:</b></td><td><span class="code-argument">_data</span> </td><td> string where to add the elements</td></tr>
<td><b>Parameter [input]:</b></td><td><span class="code-argument">current</span> </td><td> indentation of the file</td></tr>
<tr><td><b>Return: </b></td><td></td><td>false if an error occured.</td></tr></table>
</ul>
<br/>
<hr/>
<a id="4098"/><h3>transfertIn</h3><pre>
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >bool</span> <span class="code-function">transfertIn</span> (<a class="code-type" href="class_ejson__Value.html">ejson::Value</a>* <span class="code-argument">_obj</span>);<br/></pre>
Tranfert all element in the element set in parameter<br/><b>Note:</b> all element is remove from the curent element.<br/> <ul>
<table class="parameter-list">
<td><b>Parameter [input] [output]:</b></td><td><span class="code-argument">_obj</span> </td><td> move all parameter in the selected element</td></tr>
<tr><td><b>Return: </b></td><td></td><td>true if transfer is done corectly</td></tr></table>
</ul>
<br/>
<hr/>
<h3>duplicate</h3><pre>
+ <span class="code-storage-keyword">virtual</span> <a class="code-type" href="class_ejson__Value.html">ejson::Value</a>* <span class="code-function">duplicate</span> () <span class="code-storage-keyword">const</span>;<br/></pre>
Copy the curent node and all the child in the curent one.<br/><ul>
<table class="parameter-list">
<tr><td><b>Return: </b></td><td></td><td>NULL in an error occured, the pointer on the element otherwise</td></tr></table>
</ul>
<br/>
<hr/>
</div>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-46753803-1', 'heeroyui.github.io');
ga('send', 'pageview');
</script>
</body>
</html>