diff options
Diffstat (limited to '')
| -rw-r--r-- | docs/doxygen/nel/a03106.html | 271 |
1 files changed, 271 insertions, 0 deletions
diff --git a/docs/doxygen/nel/a03106.html b/docs/doxygen/nel/a03106.html new file mode 100644 index 00000000..388ce57e --- /dev/null +++ b/docs/doxygen/nel/a03106.html @@ -0,0 +1,271 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>NeL: NLPACS::CPrimitiveBlock class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.3.6 --> +<div class="qindex"> <form class="search" action="search.php" method="get"> +<a class="qindex" href="main.html">Main Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical List</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="namespacemembers.html">Namespace Members</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <a class="qindex" href="pages.html">Related Pages</a> | <span class="search"><u>S</u>earch for <input class="search" type="text" name="query" value="" size="20" accesskey="s"/></span></form></div> +<h1>NLPACS::CPrimitiveBlock Class Reference</h1><code>#include <<a class="el" href="a06199.html">primitive_block.h</a>></code> +<p> +<p>Inheritance diagram for NLPACS::CPrimitiveBlock: +<p><center><img src="a03106.png" usemap="#NLPACS::CPrimitiveBlock_map" border="0" alt=""></center> +<map name="NLPACS::CPrimitiveBlock_map"> +<area href="a03938.html" alt="NLPACS::UPrimitiveBlock" shape="rect" coords="0,0,156,24"> +</map> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Block of pacs primitive <dl compact><dt><b>Author:</b></dt><dd>Cyril 'Hulud' Corvazier <p> +Nevrax France </dd></dl> +<dl compact><dt><b>Date:</b></dt><dd>2002 </dd></dl> + +<p> + +<p> +Definition at line <a class="el" href="a06199.html#l00097">97</a> of file <a class="el" href="a06199.html">pacs/primitive_block.h</a>.<table border=0 cellpadding=0 cellspacing=0> +<tr><td></td></tr> +<tr><td colspan=2><br><h2>from UPrimitive block, create a P.B. from a stream</h2></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="a04558.html#a15">uint</a> </td><td class="memItemRight" valign=bottom><a class="el" href="a03106.html#NLPACS_1_1CPrimitiveBlockz1264_0">getNbPrimitive</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">get the number of primitives in the block <a href="#NLPACS_1_1CPrimitiveBlockz1264_0"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="a02947.html#NLPACS_1_1UMovePrimitivew14">UMovePrimitive::TUserData</a> </td><td class="memItemRight" valign=bottom><a class="el" href="a03106.html#NLPACS_1_1CPrimitiveBlockz1264_1">getUserData</a> (<a class="el" href="a04558.html#a15">uint</a> nPrimNb)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">return the user data for a primitive of the block <a href="#NLPACS_1_1CPrimitiveBlockz1264_1"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="a03938.html">UPrimitiveBlock</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="a03106.html#NLPACS_1_1CPrimitiveBlockz1264_2">createPrimitiveBlock</a> (<a class="el" href="a02270.html">NLMISC::IStream</a> &<a class="el" href="a04223.html#a652">src</a>)</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="a03938.html">UPrimitiveBlock</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="a03106.html#NLPACS_1_1CPrimitiveBlockz1264_3">createPrimitiveBlockFromFile</a> (const std::string &fileName)</td></tr> + +<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="a03106.html#NLPACS_1_1CPrimitiveBlocka0">serial</a> (<a class="el" href="a02270.html">NLMISC::IStream</a> &<a class="el" href="a04223.html#a626">s</a>)</td></tr> + +<tr><td colspan=2><br><h2>Data Fields</h2></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>std::vector< <a class="el" href="a03115.html">CPrimitiveDesc</a> > </td><td class="memItemRight" valign=bottom><a class="el" href="a03106.html#NLPACS_1_1CPrimitiveBlocko0">Primitives</a></td></tr> + +</table> +<hr><h2>Member Function Documentation</h2> +<a class="anchor" name="NLPACS_1_1CPrimitiveBlockz1264_2" doxytag="NLPACS::CPrimitiveBlock::createPrimitiveBlock" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> <a class="el" href="a03938.html">UPrimitiveBlock</a>* NLPACS::CPrimitiveBlock::createPrimitiveBlock </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="a02270.html">NLMISC::IStream</a> & </td> + <td class="mdname1" valign="top" nowrap> <em>src</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap><code> [static]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Create a primitive block from a stream. This may raise exception if loading failed +<p> +Reimplemented from <a class="el" href="a03938.html#NLPACS_1_1UPrimitiveBlocke0">NLPACS::UPrimitiveBlock</a>. </td> + </tr> +</table> +<a class="anchor" name="NLPACS_1_1CPrimitiveBlockz1264_3" doxytag="NLPACS::CPrimitiveBlock::createPrimitiveBlockFromFile" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> <a class="el" href="a03938.html">UPrimitiveBlock</a>* NLPACS::CPrimitiveBlock::createPrimitiveBlockFromFile </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const std::string & </td> + <td class="mdname1" valign="top" nowrap> <em>fileName</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap><code> [static]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Create a primitive block from its file name. This may raise exceptions if loading failed. +<p> +Reimplemented from <a class="el" href="a03938.html#NLPACS_1_1UPrimitiveBlocke1">NLPACS::UPrimitiveBlock</a>. </td> + </tr> +</table> +<a class="anchor" name="NLPACS_1_1CPrimitiveBlockz1264_0" doxytag="NLPACS::CPrimitiveBlock::getNbPrimitive" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> <a class="el" href="a04558.html#a15">uint</a> NLPACS::CPrimitiveBlock::getNbPrimitive </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap><code> [inline, virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +get the number of primitives in the block +<p> + +<p> +Implements <a class="el" href="a03938.html#NLPACS_1_1UPrimitiveBlocka0">NLPACS::UPrimitiveBlock</a>. +<p> +Definition at line <a class="el" href="a06199.html#l00111">111</a> of file <a class="el" href="a06199.html">pacs/primitive_block.h</a>. +<p> +References <a class="el" href="a06199.html#l00102">Primitives</a>, and <a class="el" href="a05981.html#l00105">uint</a>. +<p> +<div class="fragment"><pre>00111 { <span class="keywordflow">return</span> <a class="code" href="a03106.html#NLPACS_1_1CPrimitiveBlocko0">Primitives</a>.size(); } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLPACS_1_1CPrimitiveBlockz1264_1" doxytag="NLPACS::CPrimitiveBlock::getUserData" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> <a class="el" href="a02947.html#NLPACS_1_1UMovePrimitivew14">UMovePrimitive::TUserData</a> NLPACS::CPrimitiveBlock::getUserData </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="a04558.html#a15">uint</a> </td> + <td class="mdname1" valign="top" nowrap> <em>nPrimNb</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap><code> [inline, virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +return the user data for a primitive of the block +<p> + +<p> +Implements <a class="el" href="a03938.html#NLPACS_1_1UPrimitiveBlocka1">NLPACS::UPrimitiveBlock</a>. +<p> +Definition at line <a class="el" href="a06199.html#l00112">112</a> of file <a class="el" href="a06199.html">pacs/primitive_block.h</a>. +<p> +References <a class="el" href="a05622.html#l00290">nlassert</a>, <a class="el" href="a06199.html#l00102">Primitives</a>, <a class="el" href="a06615.html#l00058">NLPACS::UMovePrimitive::TUserData</a>, and <a class="el" href="a05981.html#l00105">uint</a>. +<p> +<div class="fragment"><pre>00112 { <a class="code" href="a04199.html#a6">nlassert</a>(nPrimNb < <a class="code" href="a03106.html#NLPACS_1_1CPrimitiveBlocko0">Primitives</a>.size()); +00113 <span class="keywordflow">return</span> <a class="code" href="a03106.html#NLPACS_1_1CPrimitiveBlocko0">Primitives</a>[nPrimNb].UserData; } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLPACS_1_1CPrimitiveBlocka0" doxytag="NLPACS::CPrimitiveBlock::serial" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void NLPACS::CPrimitiveBlock::serial </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="a02270.html">NLMISC::IStream</a> & </td> + <td class="mdname1" valign="top" nowrap> <em>s</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="a06200.html#l00093">93</a> of file <a class="el" href="a06200.html">primitive_block_pacs.cpp</a>. +<p> +References <a class="el" href="a06199.html#l00102">Primitives</a>, <a class="el" href="a05646.html#l00977">s</a>, and <a class="el" href="a05981.html#l00100">uint32</a>. +<p> +<div class="fragment"><pre>00094 { +00095 <a class="code" href="a04223.html#a626">s</a>.xmlPush (<span class="stringliteral">"PRIMITIVE_BLOCK"</span>); +00096 +00097 <span class="comment">// Serial checks</span> +00098 <a class="code" href="a04223.html#a626">s</a>.serialCheck ((<a class="code" href="a04558.html#a11">uint32</a>)'KBRP'); +00099 +00100 <span class="comment">// Serial the version</span> +00101 (<span class="keywordtype">void</span>)<a class="code" href="a04223.html#a626">s</a>.serialVersion (0); +00102 +00103 <a class="code" href="a04223.html#a626">s</a>.xmlPush (<span class="stringliteral">"PRIMITIVES"</span>); +00104 <a class="code" href="a04223.html#a626">s</a>.serialCont (Primitives); +00105 <a class="code" href="a04223.html#a626">s</a>.xmlPop (); +00106 +00107 <a class="code" href="a04223.html#a626">s</a>.xmlPop (); +00108 } +</pre></div> </td> + </tr> +</table> +<hr><h2>Field Documentation</h2> +<a class="anchor" name="NLPACS_1_1CPrimitiveBlocko0" doxytag="NLPACS::CPrimitiveBlock::Primitives" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> std::vector<<a class="el" href="a03115.html">CPrimitiveDesc</a>> <a class="el" href="a03106.html#NLPACS_1_1CPrimitiveBlocko0">NLPACS::CPrimitiveBlock::Primitives</a> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="a06199.html#l00102">102</a> of file <a class="el" href="a06199.html">pacs/primitive_block.h</a>. +<p> +Referenced by <a class="el" href="a06199.html#l00111">getNbPrimitive()</a>, <a class="el" href="a06199.html#l00112">getUserData()</a>, and <a class="el" href="a06200.html#l00093">serial()</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following files:<ul> +<li><a class="el" href="a06199.html">pacs/primitive_block.h</a><li><a class="el" href="a06200.html">primitive_block_pacs.cpp</a></ul> +<hr size="1"><address style="align: right;"><small>Generated on Tue Mar 16 14:19:51 2004 for NeL by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border=0 > +</a>1.3.6 </small></address> +</body> +</html> |