aboutsummaryrefslogtreecommitdiff
path: root/docs/doxygen/nel/a02840.html
blob: 028318f0e8acf2008c89ccd989e9dd040079856b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
<!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: NLLIGO::CMaterial 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&nbsp;Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Data&nbsp;Structures</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="namespacemembers.html">Namespace&nbsp;Members</a> | <a class="qindex" href="functions.html">Data&nbsp;Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <a class="qindex" href="pages.html">Related&nbsp;Pages</a>  | <span class="search"><u>S</u>earch&nbsp;for&nbsp;<input class="search" type="text" name="query" value="" size="20" accesskey="s"/></span></form></div>
<h1>NLLIGO::CMaterial Class Reference</h1><code>#include &lt;<a class="el" href="a05908.html">ligo_material.h</a>&gt;</code>
<p>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A ligoscape material<p>
<dl compact><dt><b>Author:</b></dt><dd>Cyril 'Hulud' Corvazier <p>
Nevrax France </dd></dl>
<dl compact><dt><b>Date:</b></dt><dd>2001 </dd></dl>

<p>

<p>
Definition at line <a class="el" href="a05908.html#l00048">48</a> of file <a class="el" href="a05908.html">ligo_material.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>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a02840.html#NLLIGO_1_1CMateriala0">build</a> (const <a class="el" href="a03764.html">CZoneTemplate</a> &amp;tplt, const <a class="el" href="a02756.html">CLigoConfig</a> &amp;config, <a class="el" href="a02757.html">CLigoError</a> &amp;errors)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Build method.  <a href="#NLLIGO_1_1CMateriala0"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>const <a class="el" href="a03737.html">CZoneEdge</a> &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a02840.html#NLLIGO_1_1CMateriala1">getEdge</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the material edge.  <a href="#NLLIGO_1_1CMateriala1"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a02840.html#NLLIGO_1_1CMateriala2">serial</a> (<a class="el" href="a02270.html">NLMISC::IStream</a> &amp;<a class="el" href="a04223.html#a626">s</a>)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Serial method.  <a href="#NLLIGO_1_1CMateriala2"></a><br><br></td></tr>
<tr><td colspan=2><br><h2>Private Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="a03737.html">CZoneEdge</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a02840.html#NLLIGO_1_1CMaterialr0">_ZoneEdge</a></td></tr>

</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="NLLIGO_1_1CMateriala0" doxytag="NLLIGO::CMaterial::build" ></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"> bool NLLIGO::CMaterial::build </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">const <a class="el" href="a03764.html">CZoneTemplate</a> &amp;&nbsp;</td>
          <td class="mdname" nowrap> <em>tplt</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap>const <a class="el" href="a02756.html">CLigoConfig</a> &amp;&nbsp;</td>
          <td class="mdname" nowrap> <em>config</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap><a class="el" href="a02757.html">CLigoError</a> &amp;&nbsp;</td>
          <td class="mdname" nowrap> <em>errors</em></td>
        </tr>
        <tr>
          <td></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Build method. 
<p>

<p>
Definition at line <a class="el" href="a05907.html#l00038">38</a> of file <a class="el" href="a05907.html">ligo_material.cpp</a>.
<p>
References <a class="el" href="a05908.html#l00064">_ZoneEdge</a>, <a class="el" href="a05905.html#l00080">NLLIGO::CLigoError::clear()</a>, <a class="el" href="a06781.html#l00068">NLLIGO::CZoneTemplate::getEdges()</a>, <a class="el" href="a05906.html#l00124">NLLIGO::CLigoError::MainError</a>, and <a class="el" href="a05981.html#l00105">uint</a>.
<p>
<div class="fragment"><pre>00039 {
00040         <span class="comment">// Clear errors</span>
00041         errors.clear ();
00042 
00043         <span class="comment">// Edge vector</span>
00044         <span class="keyword">const</span> std::vector&lt;CZoneEdge&gt; &amp;edges = tplt.getEdges ();
00045 
00046         <span class="comment">// This template should have 4 edges</span>
00047         <span class="keywordflow">if</span> (edges.size() != 4)
00048         {
00049                 errors.MainError = CLigoError::MustHave4Edges;
00050                 <span class="keywordflow">return</span> <span class="keyword">false</span>;
00051         }
00052 
00053         <span class="comment">// The 1st edge must be symetrical</span>
00054         <span class="keywordflow">if</span> (!edges[0].isSymetrical (config, errors))
00055                 <span class="keywordflow">return</span> <span class="keyword">false</span>;
00056 
00057         <span class="comment">// Error code</span>
00058         <span class="keywordtype">bool</span> ok = <span class="keyword">true</span>;
00059 
00060         <span class="comment">// The others must be the same edges</span>
00061         <a class="code" href="a04558.html#a15">uint</a> edge;
00062         <span class="keywordflow">for</span> (edge=1; edge&lt;edges.size(); edge++)
00063         {
00064                 <span class="comment">// The same edge ?</span>
00065                 <span class="keywordflow">if</span> (!edges[0].isTheSame (edges[edge], config, errors))
00066                 {
00067                         <span class="comment">// Error</span>
00068                         ok = <span class="keyword">false</span>;
00069                 }
00070         }
00071 
00072         <span class="comment">// Build ?</span>
00073         <span class="keywordflow">if</span> (ok)
00074         {
00075                 <span class="comment">// Ok, build the material</span>
00076                 <a class="code" href="a02840.html#NLLIGO_1_1CMaterialr0">_ZoneEdge</a> = edges[0];
00077         }
00078 
00079         <span class="comment">// Return error code</span>
00080         <span class="keywordflow">return</span> ok;
00081 }
</pre></div>    </td>
  </tr>
</table>
<a class="anchor" name="NLLIGO_1_1CMateriala1" doxytag="NLLIGO::CMaterial::getEdge" ></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"> const <a class="el" href="a03737.html">CZoneEdge</a>&amp; NLLIGO::CMaterial::getEdge </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap> const<code> [inline]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Return the material edge. 
<p>

<p>
Definition at line <a class="el" href="a05908.html#l00056">56</a> of file <a class="el" href="a05908.html">ligo_material.h</a>.
<p>
References <a class="el" href="a05908.html#l00064">_ZoneEdge</a>.
<p>
Referenced by <a class="el" href="a06578.html#l00068">NLLIGO::CTransition::build()</a>.
<p>
<div class="fragment"><pre>00056 { <span class="keywordflow">return</span> <a class="code" href="a02840.html#NLLIGO_1_1CMaterialr0">_ZoneEdge</a>; }
</pre></div>    </td>
  </tr>
</table>
<a class="anchor" name="NLLIGO_1_1CMateriala2" doxytag="NLLIGO::CMaterial::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 NLLIGO::CMaterial::serial </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="a02270.html">NLMISC::IStream</a> &amp;&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>s</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Serial method. 
<p>

<p>
Definition at line <a class="el" href="a05907.html#l00085">85</a> of file <a class="el" href="a05907.html">ligo_material.cpp</a>.
<p>
References <a class="el" href="a05908.html#l00064">_ZoneEdge</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>00086 {
00087         <span class="comment">// Serial the main node</span>
00088         <a class="code" href="a04223.html#a626">s</a>.xmlPush (<span class="stringliteral">"LIGO_MATERIAL"</span>);
00089 
00090                 <span class="comment">// Serial the header</span>
00091                 <a class="code" href="a04223.html#a626">s</a>.serialCheck ((<a class="code" href="a04558.html#a11">uint32</a>)'TMOL');
00092 
00093                 <span class="comment">// Serial the version</span>
00094                 <span class="comment">/*sint ver =*/</span> <a class="code" href="a04223.html#a626">s</a>.serialVersion (0);
00095 
00096                 <span class="comment">// Serial the zoneedge</span>
00097                 <a class="code" href="a04223.html#a626">s</a>.xmlSerial (_ZoneEdge, <span class="stringliteral">"ZONE_EDGE"</span>);
00098 
00099         <span class="comment">// Close the main node</span>
00100         <a class="code" href="a04223.html#a626">s</a>.xmlPop ();
00101 }
</pre></div>    </td>
  </tr>
</table>
<hr><h2>Field Documentation</h2>
<a class="anchor" name="NLLIGO_1_1CMaterialr0" doxytag="NLLIGO::CMaterial::_ZoneEdge" ></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="a03737.html">CZoneEdge</a> <a class="el" href="a02840.html#NLLIGO_1_1CMaterialr0">NLLIGO::CMaterial::_ZoneEdge</a><code> [private]</code>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>

<p>
Definition at line <a class="el" href="a05908.html#l00064">64</a> of file <a class="el" href="a05908.html">ligo_material.h</a>.
<p>
Referenced by <a class="el" href="a05907.html#l00038">build()</a>, <a class="el" href="a05908.html#l00056">getEdge()</a>, and <a class="el" href="a05907.html#l00085">serial()</a>.    </td>
  </tr>
</table>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="a05908.html">ligo_material.h</a><li><a class="el" href="a05907.html">ligo_material.cpp</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Tue Mar 16 12:47:58 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>