diff options
Diffstat (limited to 'docs/doxygen/nel/a03938.html')
| -rw-r--r-- | docs/doxygen/nel/a03938.html | 251 |
1 files changed, 251 insertions, 0 deletions
diff --git a/docs/doxygen/nel/a03938.html b/docs/doxygen/nel/a03938.html new file mode 100644 index 00000000..46bc7644 --- /dev/null +++ b/docs/doxygen/nel/a03938.html @@ -0,0 +1,251 @@ +<!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::UPrimitiveBlock 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::UPrimitiveBlock Class Reference</h1><code>#include <<a class="el" href="a06621.html">u_primitive_block.h</a>></code> +<p> +<p>Inheritance diagram for NLPACS::UPrimitiveBlock: +<p><center><img src="a03938.png" usemap="#NLPACS::UPrimitiveBlock_map" border="0" alt=""></center> +<map name="NLPACS::UPrimitiveBlock_map"> +<area href="a03106.html" alt="NLPACS::CPrimitiveBlock" shape="rect" coords="0,56,156,80"> +</map> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Block of pacs primitives, user interface. They can be created from a stream (*.pacs_prim) A primitive block can be instanciated in a move container. <dl compact><dt><b>Author:</b></dt><dd>Nicolas Vizerie <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="a06621.html#l00046">46</a> of file <a class="el" href="a06621.html">u_primitive_block.h</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>virtual <a class="el" href="a04558.html#a15">uint</a> </td><td class="memItemRight" valign=bottom><a class="el" href="a03938.html#NLPACS_1_1UPrimitiveBlocka0">getNbPrimitive</a> ()=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">get the number of primitives in the block <a href="#NLPACS_1_1UPrimitiveBlocka0"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="a02947.html#NLPACS_1_1UMovePrimitivew14">UMovePrimitive::TUserData</a> </td><td class="memItemRight" valign=bottom><a class="el" href="a03938.html#NLPACS_1_1UPrimitiveBlocka1">getUserData</a> (<a class="el" href="a04558.html#a15">uint</a> nPrimNb)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">return the user data for a primitive of the block <a href="#NLPACS_1_1UPrimitiveBlocka1"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual </td><td class="memItemRight" valign=bottom><a class="el" href="a03938.html#NLPACS_1_1UPrimitiveBlocka2">~UPrimitiveBlock</a> ()</td></tr> + +<tr><td colspan=2><br><h2>Static Public Member Functions</h2></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="a03938.html#NLPACS_1_1UPrimitiveBlocke0">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="a03938.html#NLPACS_1_1UPrimitiveBlocke1">createPrimitiveBlockFromFile</a> (const std::string &fileName)</td></tr> + +</table> +<hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="NLPACS_1_1UPrimitiveBlocka2" doxytag="NLPACS::UPrimitiveBlock::~UPrimitiveBlock" ></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"> virtual NLPACS::UPrimitiveBlock::~<a class="el" href="a03938.html">UPrimitiveBlock</a> </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> + +<p> +Definition at line <a class="el" href="a06621.html#l00050">50</a> of file <a class="el" href="a06621.html">u_primitive_block.h</a>. +<p> +<div class="fragment"><pre>00050 {} +</pre></div> </td> + </tr> +</table> +<hr><h2>Member Function Documentation</h2> +<a class="anchor" name="NLPACS_1_1UPrimitiveBlocke0" doxytag="NLPACS::UPrimitiveBlock::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::UPrimitiveBlock::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 in <a class="el" href="a03106.html#NLPACS_1_1CPrimitiveBlockz1264_2">NLPACS::CPrimitiveBlock</a>. +<p> +Definition at line <a class="el" href="a06200.html#l00111">111</a> of file <a class="el" href="a06200.html">primitive_block_pacs.cpp</a>. +<p> +References <a class="el" href="a05622.html#l00290">nlassert</a>, and <a class="el" href="a05646.html#l01124">src</a>. +<p> +Referenced by <a class="el" href="a06200.html#l00122">createPrimitiveBlockFromFile()</a>. +<p> +<div class="fragment"><pre>00112 { +00113 NL_ALLOC_CONTEXT( Pacs ) +00114 +00115 <a class="code" href="a04199.html#a6">nlassert</a>(<a class="code" href="a04223.html#a652">src</a>.isReading()); +00116 std::auto_ptr<CPrimitiveBlock> pb(<span class="keyword">new</span> CPrimitiveBlock); +00117 pb->serial(src); +00118 <span class="keywordflow">return</span> pb.release(); +00119 } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLPACS_1_1UPrimitiveBlocke1" doxytag="NLPACS::UPrimitiveBlock::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::UPrimitiveBlock::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 in <a class="el" href="a03106.html#NLPACS_1_1CPrimitiveBlockz1264_3">NLPACS::CPrimitiveBlock</a>. +<p> +Definition at line <a class="el" href="a06200.html#l00122">122</a> of file <a class="el" href="a06200.html">primitive_block_pacs.cpp</a>. +<p> +References <a class="el" href="a06200.html#l00111">createPrimitiveBlock()</a>, and <a class="el" href="a05708.html#l00135">NLMISC::CIFile::open()</a>. +<p> +<div class="fragment"><pre>00123 { +00124 NL_ALLOC_CONTEXT( Pacs ) +00125 +00126 <a class="code" href="a02653.html">NLMISC::CIFile</a> input; +00127 <span class="keywordflow">if</span> (input.<a class="code" href="a02653.html#NLMISC_1_1CIFilea12">open</a>(fileName)) +00128 { +00129 NLMISC::CIXml xmlInput; +00130 <span class="comment">// Init</span> +00131 <span class="keywordflow">if</span> (xmlInput.init (input)) +00132 { +00133 <span class="keywordflow">return</span> <a class="code" href="a03938.html#NLPACS_1_1UPrimitiveBlocke0">createPrimitiveBlock</a>(xmlInput); +00134 } +00135 <span class="keywordflow">else</span> +00136 { +00137 <span class="keywordflow">throw</span> <a class="code" href="a02482.html">NLMISC::Exception</a>(std::string(<span class="stringliteral">"Unable to init an xml input file from "</span>) + fileName); +00138 } +00139 } +00140 <span class="keywordflow">return</span> NULL; +00141 } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLPACS_1_1UPrimitiveBlocka0" doxytag="NLPACS::UPrimitiveBlock::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"> virtual <a class="el" href="a04558.html#a15">uint</a> NLPACS::UPrimitiveBlock::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> [pure 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> +Implemented in <a class="el" href="a03106.html#NLPACS_1_1CPrimitiveBlockz1264_0">NLPACS::CPrimitiveBlock</a>. </td> + </tr> +</table> +<a class="anchor" name="NLPACS_1_1UPrimitiveBlocka1" doxytag="NLPACS::UPrimitiveBlock::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"> virtual <a class="el" href="a02947.html#NLPACS_1_1UMovePrimitivew14">UMovePrimitive::TUserData</a> NLPACS::UPrimitiveBlock::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> [pure 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> +Implemented in <a class="el" href="a03106.html#NLPACS_1_1CPrimitiveBlockz1264_1">NLPACS::CPrimitiveBlock</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following files:<ul> +<li><a class="el" href="a06621.html">u_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:26:37 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> |