<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>libqalculate-0.9.7: DataObject 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.5 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li class="current"><a href="classes.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="classes.html"><span>Alphabetical List</span></a></li>
<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>
<div class="contents">
<h1>DataObject Class Reference</h1><!-- doxytag: class="DataObject" -->A a data set object.
<a href="#_details">More...</a>
<p>
<code>#include <DataSet.h></code>
<p>
<p>
<a href="classDataObject-members.html">List of all members.</a><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="classDataObject.html#862ae290dc1c257f082b361bcd1a4282">DataObject</a> (<a class="el" href="classDataSet.html">DataSet</a> *parent_set)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDataObject.html#46bb884f1a5cafb91c257b73e2470fbb">eraseProperty</a> (<a class="el" href="classDataProperty.html">DataProperty</a> *property)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDataObject.html#7f31c82ca9c57f841aea4daf24654292">setProperty</a> (<a class="el" href="classDataProperty.html">DataProperty</a> *property, string s_value, int is_approximate=-1)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDataObject.html#e43b39147e4c90dfe12280b3e9a2e311">setNonlocalizedKeyProperty</a> (<a class="el" href="classDataProperty.html">DataProperty</a> *property, string s_value)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="classMathStructure.html">MathStructure</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classDataObject.html#e2a81a865179dde93c41e8af315c4cd5">getPropertyStruct</a> (<a class="el" href="classDataProperty.html">DataProperty</a> *property)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classDataObject.html#491005c8bc249af91fd5fb83298ba84e">getProperty</a> (<a class="el" href="classDataProperty.html">DataProperty</a> *property, int *is_approximate=NULL)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classDataObject.html#d30203fa69ca91ec6c9df8c9e6845da4">getNonlocalizedKeyProperty</a> (<a class="el" href="classDataProperty.html">DataProperty</a> *property)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="classDataObject.html#fc0661281842298f866edc3f3bee1ea0">getPropertyInputString</a> (<a class="el" href="classDataProperty.html">DataProperty</a> *property)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="classDataObject.html#27d8b7c11c1e789f3925b3ddae6fe8ca">getPropertyDisplayString</a> (<a class="el" href="classDataProperty.html">DataProperty</a> *property)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classDataObject.html#e21c156a897d4d757e92ab820c2cbbf3">isUserModified</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDataObject.html#36b62dafaf2d570877c3140543464173">setUserModified</a> (bool user_modified=true)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classDataSet.html">DataSet</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classDataObject.html#a1a83288fe02b12d5822ce90b7b22145">parentSet</a> () const </td></tr>
<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="650130e3f31a1339ad01d2edfaf6e610"></a><!-- doxytag: member="DataObject::properties" ref="650130e3f31a1339ad01d2edfaf6e610" args="" -->
vector< <a class="el" href="classDataProperty.html">DataProperty</a> * > </td><td class="memItemRight" valign="bottom"><b>properties</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0014022010da571501d295223690a001"></a><!-- doxytag: member="DataObject::s_properties" ref="0014022010da571501d295223690a001" args="" -->
vector< string > </td><td class="memItemRight" valign="bottom"><b>s_properties</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="834e79f600cbca92adca993cc3fad3ae"></a><!-- doxytag: member="DataObject::s_nonlocalized_properties" ref="834e79f600cbca92adca993cc3fad3ae" args="" -->
vector< string > </td><td class="memItemRight" valign="bottom"><b>s_nonlocalized_properties</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="568bd31ce22b552273ad4945baded912"></a><!-- doxytag: member="DataObject::m_properties" ref="568bd31ce22b552273ad4945baded912" args="" -->
vector< <a class="el" href="classMathStructure.html">MathStructure</a> * > </td><td class="memItemRight" valign="bottom"><b>m_properties</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="388a9ff8e19852d592ec770e52e653fa"></a><!-- doxytag: member="DataObject::a_properties" ref="388a9ff8e19852d592ec770e52e653fa" args="" -->
vector< int > </td><td class="memItemRight" valign="bottom"><b>a_properties</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7f8a774243ab469a8b1349af6e4f8377"></a><!-- doxytag: member="DataObject::parent" ref="7f8a774243ab469a8b1349af6e4f8377" args="" -->
<a class="el" href="classDataSet.html">DataSet</a> * </td><td class="memItemRight" valign="bottom"><b>parent</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="13628d2aa0c61fc7c27b7b763de16a65"></a><!-- doxytag: member="DataObject::b_uchanged" ref="13628d2aa0c61fc7c27b7b763de16a65" args="" -->
bool </td><td class="memItemRight" valign="bottom"><b>b_uchanged</b></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A a data set object.
<p>
Data objects consist of property-value pairs. <hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="862ae290dc1c257f082b361bcd1a4282"></a><!-- doxytag: member="DataObject::DataObject" ref="862ae290dc1c257f082b361bcd1a4282" args="(DataSet *parent_set)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">DataObject::DataObject </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classDataSet.html">DataSet</a> * </td>
<td class="paramname"> <em>parent_set</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Create a data object.<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>parent_set</em> </td><td>Data set that the object will belong to. </td></tr>
</table>
</dl>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="46bb884f1a5cafb91c257b73e2470fbb"></a><!-- doxytag: member="DataObject::eraseProperty" ref="46bb884f1a5cafb91c257b73e2470fbb" args="(DataProperty *property)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void DataObject::eraseProperty </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classDataProperty.html">DataProperty</a> * </td>
<td class="paramname"> <em>property</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Unset (erase value) a property.<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>property</em> </td><td>Property to unset. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="7f31c82ca9c57f841aea4daf24654292"></a><!-- doxytag: member="DataObject::setProperty" ref="7f31c82ca9c57f841aea4daf24654292" args="(DataProperty *property, string s_value, int is_approximate=-1)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void DataObject::setProperty </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classDataProperty.html">DataProperty</a> * </td>
<td class="paramname"> <em>property</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">string </td>
<td class="paramname"> <em>s_value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>is_approximate</em> = <code>-1</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set value for a property.<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>property</em> </td><td>Property to set (must belong to parent data set). </td></tr>
<tr><td valign="top"></td><td valign="top"><em>s_vale</em> </td><td>Value for the property. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>is_approximate</em> </td><td>If the value is approximate. 1 for approximate, 0 for exact, -1 for property default. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="e43b39147e4c90dfe12280b3e9a2e311"></a><!-- doxytag: member="DataObject::setNonlocalizedKeyProperty" ref="e43b39147e4c90dfe12280b3e9a2e311" args="(DataProperty *property, string s_value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void DataObject::setNonlocalizedKeyProperty </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classDataProperty.html">DataProperty</a> * </td>
<td class="paramname"> <em>property</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">string </td>
<td class="paramname"> <em>s_value</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set an untranslated value for a key property. Used when a text value is translated, but the original value still is needed as a reference key.<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>property</em> </td><td>Property to set (must belong to parent data set). </td></tr>
<tr><td valign="top"></td><td valign="top"><em>s_vale</em> </td><td>Value for the property. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="e2a81a865179dde93c41e8af315c4cd5"></a><!-- doxytag: member="DataObject::getPropertyStruct" ref="e2a81a865179dde93c41e8af315c4cd5" args="(DataProperty *property)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classMathStructure.html">MathStructure</a>* DataObject::getPropertyStruct </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classDataProperty.html">DataProperty</a> * </td>
<td class="paramname"> <em>property</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns parsed value for a property. Parses the text string value if not parsed before<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>property</em> </td><td>Property to read. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Parsed value or NULL if property value is not set. </dd></dl>
</div>
</div><p>
<a class="anchor" name="491005c8bc249af91fd5fb83298ba84e"></a><!-- doxytag: member="DataObject::getProperty" ref="491005c8bc249af91fd5fb83298ba84e" args="(DataProperty *property, int *is_approximate=NULL)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const string& DataObject::getProperty </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classDataProperty.html">DataProperty</a> * </td>
<td class="paramname"> <em>property</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"> <em>is_approximate</em> = <code>NULL</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns unparsed value for a property.<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>property</em> </td><td>Property to read. </td></tr>
<tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>is_approximate</em> </td><td>If the value is approximate. Is set to 1 for approximate, 0 for exact, -1 for property default, if not NULL. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Unparsed value or empty string if property value is not set. </dd></dl>
</div>
</div><p>
<a class="anchor" name="d30203fa69ca91ec6c9df8c9e6845da4"></a><!-- doxytag: member="DataObject::getNonlocalizedKeyProperty" ref="d30203fa69ca91ec6c9df8c9e6845da4" args="(DataProperty *property)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const string& DataObject::getNonlocalizedKeyProperty </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classDataProperty.html">DataProperty</a> * </td>
<td class="paramname"> <em>property</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns unparsed untranslated value for a key property. Used when a text value is translated, but the original value still is needed as a reference key.<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>property</em> </td><td>Property to read. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Unparsed untranslated value or empty string if property value is not set. </dd></dl>
</div>
</div><p>
<a class="anchor" name="fc0661281842298f866edc3f3bee1ea0"></a><!-- doxytag: member="DataObject::getPropertyInputString" ref="fc0661281842298f866edc3f3bee1ea0" args="(DataProperty *property)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">string DataObject::getPropertyInputString </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classDataProperty.html">DataProperty</a> * </td>
<td class="paramname"> <em>property</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns value for a property in a format suitable for use in expressions with unit appended.<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>property</em> </td><td>Property to read. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Value in input format or empty string if property value is not set. </dd></dl>
</div>
</div><p>
<a class="anchor" name="27d8b7c11c1e789f3925b3ddae6fe8ca"></a><!-- doxytag: member="DataObject::getPropertyDisplayString" ref="27d8b7c11c1e789f3925b3ddae6fe8ca" args="(DataProperty *property)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">string DataObject::getPropertyDisplayString </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classDataProperty.html">DataProperty</a> * </td>
<td class="paramname"> <em>property</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns value for a property in a format suitable for display with unit appended.<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>property</em> </td><td>Property to read. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Value in display format or empty string if property value is not set. </dd></dl>
</div>
</div><p>
<a class="anchor" name="e21c156a897d4d757e92ab820c2cbbf3"></a><!-- doxytag: member="DataObject::isUserModified" ref="e21c156a897d4d757e92ab820c2cbbf3" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool DataObject::isUserModified </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
If the object has been modified by the end user (if <a class="el" href="classDataObject.html#36b62dafaf2d570877c3140543464173">setUserModified()</a> has been called).<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true if the object has been modified by the user. </dd></dl>
</div>
</div><p>
<a class="anchor" name="36b62dafaf2d570877c3140543464173"></a><!-- doxytag: member="DataObject::setUserModified" ref="36b62dafaf2d570877c3140543464173" args="(bool user_modified=true)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void DataObject::setUserModified </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>user_modified</em> = <code>true</code> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Specify if the object has been modified by the end user.<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>user_modified</em> </td><td>true if the object has been modified by the user. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="a1a83288fe02b12d5822ce90b7b22145"></a><!-- doxytag: member="DataObject::parentSet" ref="a1a83288fe02b12d5822ce90b7b22145" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classDataSet.html">DataSet</a>* DataObject::parentSet </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the data set that the object belongs to.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Parent data set. </dd></dl>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>libqalculate/<a class="el" href="DataSet_8h.html">DataSet.h</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Tue Jan 5 08:26:29 2010 for libqalculate-0.9.7 by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address>
</body>
</html>
distrib
>
Mageia
>
5
>
i586
>
media
>
core-release
>
by-pkgid
>
3ef76ad7219246424c2f43bbe981fa80
>
files
>
58
