Files
xerces-c-3.0.0/doc/html/apiDocs-3/classXSModelGroup.html
T
jens adea0d681b Initial import
git-svn-id: http://moon:8086/svn/software/trunk/libsrc/xerces-c-3.0.0@1 b431acfa-c32f-4a4a-93f1-934dc6c82436
2014-07-19 07:44:42 +00:00

293 lines
16 KiB
HTML
Executable File

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>Xerces-C++: XSModelGroup 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.4 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;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>
<li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
</ul>
</div>
<h1>XSModelGroup Class Reference</h1><!-- doxytag: class="XSModelGroup" --><!-- doxytag: inherits="XSObject" --><div class="dynheader">
Inheritance diagram for XSModelGroup:</div>
<div class="dynsection">
<p><center><img src="classXSModelGroup.png" usemap="#XSModelGroup_map" border="0" alt=""></center>
<map name="XSModelGroup_map">
<area href="classXSObject.html" alt="XSObject" shape="rect" coords="0,56,99,80">
<area href="classXMemory.html" alt="XMemory" shape="rect" coords="0,0,99,24">
</map>
</div>
<p>
<a href="classXSModelGroup-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 Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXSModelGroup.html#c049250d99425d3e8ecac62b30a83569">COMPOSITOR_TYPE</a> { <a class="el" href="classXSModelGroup.html#c049250d99425d3e8ecac62b30a835695fc8be2305101863c2af62311c4faa1f">COMPOSITOR_SEQUENCE</a> = 1,
<a class="el" href="classXSModelGroup.html#c049250d99425d3e8ecac62b30a8356999d02c72acc4ee70f51e6e1f89f8600a">COMPOSITOR_CHOICE</a> = 2,
<a class="el" href="classXSModelGroup.html#c049250d99425d3e8ecac62b30a8356917bd4cc476eb7ad8c4bcdd35cff471b1">COMPOSITOR_ALL</a> = 3
}</td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Constructors</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXSModelGroup.html#5586ce54eb3e3704668fdadd2bef8db0">XSModelGroup</a> (<a class="el" href="classXSModelGroup.html#c049250d99425d3e8ecac62b30a83569">COMPOSITOR_TYPE</a> compositorType, <a class="el" href="XSConstants_8hpp.html#bb0c88e7cb63a03ff035e6e75fcc8f53">XSParticleList</a> *const particleList, <a class="el" href="classXSAnnotation.html">XSAnnotation</a> *const annot, <a class="el" href="classXSModel.html">XSModel</a> *const xsModel, <a class="el" href="classMemoryManager.html">MemoryManager</a> *const manager=<a class="el" href="classXMLPlatformUtils.html#97eff0d9fff3567bea3acd3ca4d95252">XMLPlatformUtils::fgMemoryManager</a>)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The default constructor. <a href="#5586ce54eb3e3704668fdadd2bef8db0"></a><br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Destructor</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXSModelGroup.html#e8668b613cad5b202188190562c3bb92">~XSModelGroup</a> ()</td></tr>
<tr><td colspan="2"><div class="groupHeader">XSModelGroup methods</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classXSModelGroup.html#c049250d99425d3e8ecac62b30a83569">COMPOSITOR_TYPE</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXSModelGroup.html#b8d3bd77d56fc8631a423700076235ea">getCompositor</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">[compositor]: one of all, choice or sequence. <a href="#b8d3bd77d56fc8631a423700076235ea"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="XSConstants_8hpp.html#bb0c88e7cb63a03ff035e6e75fcc8f53">XSParticleList</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXSModelGroup.html#39db5527a4582091ab7e9896433b1671">getParticles</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A list of [particles]. <a href="#39db5527a4582091ab7e9896433b1671"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classXSAnnotation.html">XSAnnotation</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXSModelGroup.html#a29856861198043324740602f55062f7">getAnnotation</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Optional. <a href="#a29856861198043324740602f55062f7"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classXSModelGroup.html#c049250d99425d3e8ecac62b30a83569">COMPOSITOR_TYPE</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXSModelGroup.html#d1dfee0be655b46ea7228fb30d2f9179">fCompositorType</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="XSConstants_8hpp.html#bb0c88e7cb63a03ff035e6e75fcc8f53">XSParticleList</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXSModelGroup.html#e4c316510ab08cc137695833b6fa86ce">fParticleList</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classXSAnnotation.html">XSAnnotation</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXSModelGroup.html#a542d7658c5f0bf1c9bcd1e9960428b7">fAnnotation</a></td></tr>
</table>
<hr><h2>Member Enumeration Documentation</h2>
<a class="anchor" name="c049250d99425d3e8ecac62b30a83569"></a><!-- doxytag: member="XSModelGroup::COMPOSITOR_TYPE" ref="c049250d99425d3e8ecac62b30a83569" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classXSModelGroup.html#c049250d99425d3e8ecac62b30a83569">XSModelGroup::COMPOSITOR_TYPE</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" name="c049250d99425d3e8ecac62b30a835695fc8be2305101863c2af62311c4faa1f"></a><!-- doxytag: member="COMPOSITOR_SEQUENCE" ref="c049250d99425d3e8ecac62b30a835695fc8be2305101863c2af62311c4faa1f" args="" -->COMPOSITOR_SEQUENCE</em>&nbsp;</td><td>
This constant value signifies a sequence operator. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="c049250d99425d3e8ecac62b30a8356999d02c72acc4ee70f51e6e1f89f8600a"></a><!-- doxytag: member="COMPOSITOR_CHOICE" ref="c049250d99425d3e8ecac62b30a8356999d02c72acc4ee70f51e6e1f89f8600a" args="" -->COMPOSITOR_CHOICE</em>&nbsp;</td><td>
This constant value signifies a choice operator. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="c049250d99425d3e8ecac62b30a8356917bd4cc476eb7ad8c4bcdd35cff471b1"></a><!-- doxytag: member="COMPOSITOR_ALL" ref="c049250d99425d3e8ecac62b30a8356917bd4cc476eb7ad8c4bcdd35cff471b1" args="" -->COMPOSITOR_ALL</em>&nbsp;</td><td>
This content model represents a simplified version of the SGML &amp;-Connector and is limited to the top-level of any content model.
<p>
No element in the all content model may appear more than once. </td></tr>
</table>
</dl>
</div>
</div><p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="5586ce54eb3e3704668fdadd2bef8db0"></a><!-- doxytag: member="XSModelGroup::XSModelGroup" ref="5586ce54eb3e3704668fdadd2bef8db0" args="(COMPOSITOR_TYPE compositorType, XSParticleList *const particleList, XSAnnotation *const annot, XSModel *const xsModel, MemoryManager *const manager=XMLPlatformUtils::fgMemoryManager)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">XSModelGroup::XSModelGroup </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classXSModelGroup.html#c049250d99425d3e8ecac62b30a83569">COMPOSITOR_TYPE</a>&nbsp;</td>
<td class="paramname"> <em>compositorType</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="XSConstants_8hpp.html#bb0c88e7cb63a03ff035e6e75fcc8f53">XSParticleList</a> *const &nbsp;</td>
<td class="paramname"> <em>particleList</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classXSAnnotation.html">XSAnnotation</a> *const &nbsp;</td>
<td class="paramname"> <em>annot</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classXSModel.html">XSModel</a> *const &nbsp;</td>
<td class="paramname"> <em>xsModel</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classMemoryManager.html">MemoryManager</a> *const &nbsp;</td>
<td class="paramname"> <em>manager</em> = <code><a class="el" href="classXMLPlatformUtils.html#97eff0d9fff3567bea3acd3ca4d95252">XMLPlatformUtils::fgMemoryManager</a></code></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The default 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>compositorType</em>&nbsp;</td><td></td></tr>
<tr><td valign="top"></td><td valign="top"><em>particleList</em>&nbsp;</td><td></td></tr>
<tr><td valign="top"></td><td valign="top"><em>annot</em>&nbsp;</td><td></td></tr>
<tr><td valign="top"></td><td valign="top"><em>xsModel</em>&nbsp;</td><td></td></tr>
<tr><td valign="top"></td><td valign="top"><em>manager</em>&nbsp;</td><td>The configurable memory manager </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="e8668b613cad5b202188190562c3bb92"></a><!-- doxytag: member="XSModelGroup::~XSModelGroup" ref="e8668b613cad5b202188190562c3bb92" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">XSModelGroup::~XSModelGroup </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="b8d3bd77d56fc8631a423700076235ea"></a><!-- doxytag: member="XSModelGroup::getCompositor" ref="b8d3bd77d56fc8631a423700076235ea" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classXSModelGroup.html#c049250d99425d3e8ecac62b30a83569">XSModelGroup::COMPOSITOR_TYPE</a> XSModelGroup::getCompositor </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
[compositor]: one of all, choice or sequence.
<p>
The valid constants values are: <code>COMPOSITOR_SEQUENCE, COMPOSITOR_CHOICE, COMPOSITOR_ALL</code>.
</div>
</div><p>
<a class="anchor" name="39db5527a4582091ab7e9896433b1671"></a><!-- doxytag: member="XSModelGroup::getParticles" ref="39db5527a4582091ab7e9896433b1671" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="XSConstants_8hpp.html#bb0c88e7cb63a03ff035e6e75fcc8f53">XSParticleList</a> * XSModelGroup::getParticles </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
A list of [particles].
<p>
</div>
</div><p>
<a class="anchor" name="a29856861198043324740602f55062f7"></a><!-- doxytag: member="XSModelGroup::getAnnotation" ref="a29856861198043324740602f55062f7" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classXSAnnotation.html">XSAnnotation</a> * XSModelGroup::getAnnotation </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Optional.
<p>
An [annotation].
</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="d1dfee0be655b46ea7228fb30d2f9179"></a><!-- doxytag: member="XSModelGroup::fCompositorType" ref="d1dfee0be655b46ea7228fb30d2f9179" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classXSModelGroup.html#c049250d99425d3e8ecac62b30a83569">COMPOSITOR_TYPE</a> <a class="el" href="classXSModelGroup.html#d1dfee0be655b46ea7228fb30d2f9179">XSModelGroup::fCompositorType</a><code> [protected]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="e4c316510ab08cc137695833b6fa86ce"></a><!-- doxytag: member="XSModelGroup::fParticleList" ref="e4c316510ab08cc137695833b6fa86ce" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="XSConstants_8hpp.html#bb0c88e7cb63a03ff035e6e75fcc8f53">XSParticleList</a>* <a class="el" href="classXSModelGroup.html#e4c316510ab08cc137695833b6fa86ce">XSModelGroup::fParticleList</a><code> [protected]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="a542d7658c5f0bf1c9bcd1e9960428b7"></a><!-- doxytag: member="XSModelGroup::fAnnotation" ref="a542d7658c5f0bf1c9bcd1e9960428b7" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classXSAnnotation.html">XSAnnotation</a>* <a class="el" href="classXSModelGroup.html#a542d7658c5f0bf1c9bcd1e9960428b7">XSModelGroup::fAnnotation</a><code> [protected]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="XSModelGroup_8hpp-source.html">XSModelGroup.hpp</a></ul>
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Sep 24 16:36:35 2008 for Xerces-C++ by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.4 </small></address>
</body>
</html>