blob: ab3f406fd0d424cc52a3e68373bcc9237db28c2b (
plain) (
blame)
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
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>libVOTable: votElement.c File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.9 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>votElement.c File Reference</h1>(Private) Methods to manage XML elements.
<a href="#_details">More...</a>
<p>
<code>#include <stdio.h></code><br>
<code>#include <stdlib.h></code><br>
<code>#include <unistd.h></code><br>
<code>#include <string.h></code><br>
<code>#include "<a class="el" href="votParseP_8h_source.html">votParseP.h</a>"</code><br>
<code>#include "<a class="el" href="votParse_8h_source.html">votParse.h</a>"</code><br>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Defines</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="90be22d8acb5e625e96c4bd621873ab1"></a><!-- doxytag: member="votElement.c::outstr" ref="90be22d8acb5e625e96c4bd621873ab1" args="(s)" -->
#define </td><td class="memItemRight" valign="bottom"><b>outstr</b>(s) strcat(XML_out,s);</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f18db8ab48febb9b448b5c42bba6c8ef"></a><!-- doxytag: member="votElement.c::outattr" ref="f18db8ab48febb9b448b5c42bba6c8ef" args="(a, s)" -->
#define </td><td class="memItemRight" valign="bottom"><b>outattr</b>(a, s) {outstr(a);outstr(s);outstr("\"");}</td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="votElement_8c.html#c40e3a809b3865bd6d15bf368778e28e">vot_elemType</a> (<a class="el" href="structElement.html">Element</a> *e)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the integer value (ID) of the <a class="el" href="structElement.html" title="This is a structure that hold the information for an XML element.">Element</a> (private method). <a href="#c40e3a809b3865bd6d15bf368778e28e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="votElement_8c.html#73381f6c3509c61194a8f23ada4cac2a">vot_elemName</a> (<a class="el" href="structElement.html">Element</a> *e)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the name of the <a class="el" href="structElement.html" title="This is a structure that hold the information for an XML element.">Element</a> (private method). <a href="#73381f6c3509c61194a8f23ada4cac2a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="votElement_8c.html#c247ed61c78db54860fbbf80385f3088">vot_eType</a> (char *<a class="el" href="votElement_8c.html#5ac083a645d964373f022d03df4849c8">name</a>)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the integer value (ID) of the name (private method). <a href="#c247ed61c78db54860fbbf80385f3088"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="votElement_8c.html#bb085dd4a9d1237b43a7db3cb2a192d2">vot_elemXMLEnd</a> (<a class="el" href="structElement.html">Element</a> *e)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Build a string of the ending XML Tag (private method). <a href="#bb085dd4a9d1237b43a7db3cb2a192d2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="votElement_8c.html#478f5d941afc5695c98627cdbdfd6844">vot_elemXML</a> (<a class="el" href="structElement.html">Element</a> *e)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Builds a string of the opening XML Tag (private method). <a href="#478f5d941afc5695c98627cdbdfd6844"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structElement.html">Element</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="votElement_8c.html#744db49ce83f6ed1d76b7aa4eacd9dd9">vot_newElem</a> (unsigned int type)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Allocate a new structure of the given type (private method). <a href="#744db49ce83f6ed1d76b7aa4eacd9dd9"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Variables</h2></td></tr>
<tr><td class="memItemLeft" nowrap><a class="anchor" name="f5f0a3fb300a5bd99957571039f334c2"></a><!-- doxytag: member="votElement.c::elemTypes" ref="f5f0a3fb300a5bd99957571039f334c2" args="[]" -->
struct {</td></tr>
<tr><td class="memItemLeft" nowrap> int <b>type</b></td></tr>
<tr><td class="memItemLeft" nowrap> char * <a class="el" href="votElement_8c.html#5ac083a645d964373f022d03df4849c8">name</a></td></tr>
<tr><td class="memItemLeft" nowrap valign="top">} </td><td class="memItemRight" valign="bottom"><b>elemTypes</b> []</td></tr>
<tr><td class="memItemLeft" nowrap>struct {</td></tr>
<tr><td class="memItemLeft" nowrap> int <b>type</b></td></tr>
<tr><td class="memItemLeft" nowrap> char * <a class="el" href="votElement_8c.html#b47351fd475e3902c6d5da9e09474834">req</a></td></tr>
<tr><td class="memItemLeft" nowrap> char * <a class="el" href="votElement_8c.html#64794c1524dec8e3f98417a50ad08224">opt</a></td></tr>
<tr><td class="memItemLeft" nowrap valign="top">} </td><td class="memItemRight" valign="bottom"><a class="el" href="votElement_8c.html#3e26a3122260ebbdfd356ff07e308159">elemAttrs</a> []</td></tr>
</table>
<hr><h2>Detailed Description</h2>
(Private) Methods to manage XML elements.
<p>
VOTELEMENT.C -- (Private) Method to manage XML elements.<p>
<dl class="author" compact><dt><b>Author:</b></dt><dd>Mike Fitzpatrick and Eric Timmermann </dd></dl>
<dl class="date" compact><dt><b>Date:</b></dt><dd>8/03/09 </dd></dl>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="73381f6c3509c61194a8f23ada4cac2a"></a><!-- doxytag: member="votElement.c::vot_elemName" ref="73381f6c3509c61194a8f23ada4cac2a" args="(Element *e)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char * vot_elemName </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structElement.html">Element</a> * </td>
<td class="paramname"> <em>e</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the name of the <a class="el" href="structElement.html" title="This is a structure that hold the information for an XML element.">Element</a> (private method).
<p>
vot_elemName -- Get the name of the <a class="el" href="structElement.html" title="This is a structure that hold the information for an XML element.">Element</a> (private method).<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>*e</em> </td><td>A pointer to the <a class="el" href="structElement.html" title="This is a structure that hold the information for an XML element.">Element</a> that you want the name of </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A string pointer to the name of the element </dd></dl>
</div>
</div><p>
<a class="anchor" name="c40e3a809b3865bd6d15bf368778e28e"></a><!-- doxytag: member="votElement.c::vot_elemType" ref="c40e3a809b3865bd6d15bf368778e28e" args="(Element *e)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int vot_elemType </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structElement.html">Element</a> * </td>
<td class="paramname"> <em>e</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the integer value (ID) of the <a class="el" href="structElement.html" title="This is a structure that hold the information for an XML element.">Element</a> (private method).
<p>
vot_elemType -- Get the integer value (ID) of the <a class="el" href="structElement.html" title="This is a structure that hold the information for an XML element.">Element</a> (private method)<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>e</em> </td><td>A pointer to the <a class="el" href="structElement.html" title="This is a structure that hold the information for an XML element.">Element</a> that you want the type of </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>An integer corresponding to the type of the element </dd></dl>
</div>
</div><p>
<a class="anchor" name="478f5d941afc5695c98627cdbdfd6844"></a><!-- doxytag: member="votElement.c::vot_elemXML" ref="478f5d941afc5695c98627cdbdfd6844" args="(Element *e)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char * vot_elemXML </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structElement.html">Element</a> * </td>
<td class="paramname"> <em>e</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Builds a string of the opening XML Tag (private method).
<p>
vot_elemXML -- Builds a string of the opening XML Tag (private method)<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>*e</em> </td><td>A pointer to an <a class="el" href="structElement.html" title="This is a structure that hold the information for an XML element.">Element</a> </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A string that contains the opening XML tag for e </dd></dl>
</div>
</div><p>
<a class="anchor" name="bb085dd4a9d1237b43a7db3cb2a192d2"></a><!-- doxytag: member="votElement.c::vot_elemXMLEnd" ref="bb085dd4a9d1237b43a7db3cb2a192d2" args="(Element *e)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char * vot_elemXMLEnd </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structElement.html">Element</a> * </td>
<td class="paramname"> <em>e</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Build a string of the ending XML Tag (private method).
<p>
vot_elemXMLEnd -- Build a string of the ending XML Tag (private method)<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>*e</em> </td><td>A pointer to an <a class="el" href="structElement.html" title="This is a structure that hold the information for an XML element.">Element</a> </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A string that contains the ending XML tag for e </dd></dl>
</div>
</div><p>
<a class="anchor" name="c247ed61c78db54860fbbf80385f3088"></a><!-- doxytag: member="votElement.c::vot_eType" ref="c247ed61c78db54860fbbf80385f3088" args="(char *name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int vot_eType </td>
<td>(</td>
<td class="paramtype">char * </td>
<td class="paramname"> <em>name</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the integer value (ID) of the name (private method).
<p>
vot_eType -- Get the integer value (ID) of the name (private method).<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>name</em> </td><td>Name of the desired type </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>An integer corresponding to the type of the element </dd></dl>
</div>
</div><p>
<a class="anchor" name="744db49ce83f6ed1d76b7aa4eacd9dd9"></a><!-- doxytag: member="votElement.c::vot_newElem" ref="744db49ce83f6ed1d76b7aa4eacd9dd9" args="(unsigned int type)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structElement.html">Element</a> * vot_newElem </td>
<td>(</td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>type</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Allocate a new structure of the given type (private method).
<p>
vot_newElem -- Allocate a new structure of the given type (private method)<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>type</em> </td><td>An integer that defines the type of <a class="el" href="structElement.html" title="This is a structure that hold the information for an XML element.">Element</a> </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>An new <a class="el" href="structElement.html" title="This is a structure that hold the information for an XML element.">Element</a> structure </dd></dl>
</div>
</div><p>
<hr><h2>Variable Documentation</h2>
<a class="anchor" name="3e26a3122260ebbdfd356ff07e308159"></a><!-- doxytag: member="votElement.c::elemAttrs" ref="3e26a3122260ebbdfd356ff07e308159" args="[]" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct { ... } <a class="el" href="votElement_8c.html#3e26a3122260ebbdfd356ff07e308159">elemAttrs</a>[] </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Definition of Required and Optional attributes of VOTable elements.
</div>
</div><p>
<a class="anchor" name="5ac083a645d964373f022d03df4849c8"></a><!-- doxytag: member="votElement.c::name" ref="5ac083a645d964373f022d03df4849c8" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* <a class="el" href="votElement_8c.html#5ac083a645d964373f022d03df4849c8">name</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
element type
</div>
</div><p>
<a class="anchor" name="64794c1524dec8e3f98417a50ad08224"></a><!-- doxytag: member="votElement.c::opt" ref="64794c1524dec8e3f98417a50ad08224" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* <a class="el" href="votElement_8c.html#64794c1524dec8e3f98417a50ad08224">opt</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
required attrs
</div>
</div><p>
<a class="anchor" name="b47351fd475e3902c6d5da9e09474834"></a><!-- doxytag: member="votElement.c::req" ref="b47351fd475e3902c6d5da9e09474834" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* <a class="el" href="votElement_8c.html#b47351fd475e3902c6d5da9e09474834">req</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
element type
</div>
</div><p>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Feb 27 21:10:08 2013 for libVOTable by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
</body>
</html>
|