vendor/voclient/libvoclient/doc/html/vocSesame_8c.html


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

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>VOClient API: vocSesame.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&nbsp;Page</span></a></li>
      <li><a href="annotated.html"><span>Classes</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&nbsp;List</span></a></li>
      <li><a href="globals.html"><span>File&nbsp;Members</span></a></li>
    </ul>
  </div>
</div>
<div class="contents">
<h1>vocSesame.c File Reference</h1><code>#include &lt;stdio.h&gt;</code><br>
<code>#include &lt;stdlib.h&gt;</code><br>
<code>#include &lt;unistd.h&gt;</code><br>
<code>#include &lt;signal.h&gt;</code><br>
<code>#include &lt;errno.h&gt;</code><br>
<code>#include &lt;sys/types.h&gt;</code><br>
<code>#include &lt;sys/stat.h&gt;</code><br>
<code>#include &lt;dirent.h&gt;</code><br>
<code>#include &quot;VOClient.h&quot;</code><br>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Classes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structObject.html">Object</a></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="96522681f45fae55d1e17bcb63620e45"></a><!-- doxytag: member="vocSesame.c::_VOCLIENT_LIB_" ref="96522681f45fae55d1e17bcb63620e45" args="" -->
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>_VOCLIENT_LIB_</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cdc7844fbd4d45737d4aa56834d37829"></a><!-- doxytag: member="vocSesame.c::MAX_OBJECTS" ref="cdc7844fbd4d45737d4aa56834d37829" args="" -->
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>MAX_OBJECTS</b>&nbsp;&nbsp;&nbsp;128</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2e97c1de9ed6a4c34b8731fed4b2e624"></a><!-- doxytag: member="vocSesame.c::SZ_TARGET" ref="2e97c1de9ed6a4c34b8731fed4b2e624" args="" -->
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>SZ_TARGET</b>&nbsp;&nbsp;&nbsp;128</td></tr>

<tr><td colspan="2"><br><h2>Typedefs</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="867c408546a8562a552a59405804f607"></a><!-- doxytag: member="vocSesame.c::ObjectPtr" ref="867c408546a8562a552a59405804f607" args="" -->
typedef struct <a class="el" href="structObject.html">Object</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><b>ObjectPtr</b></td></tr>

<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">Sesame&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="vocSesame_8c.html#467c02f32e92e6808b6d1c129b8d5b04">voc_nameResolver</a> (char *target)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Query the CDS Sesame name resolver service.  <a href="#467c02f32e92e6808b6d1c129b8d5b04"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="vocSesame_8c.html#911355789d941847843c8d42ad00314a">voc_resolverPos</a> (Sesame sr)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the (ra,dec) position for the object.  <a href="#911355789d941847843c8d42ad00314a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="vocSesame_8c.html#c7d46e5f565c97b0250fe837f985e283">voc_resolverOtype</a> (Sesame sr)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return a string containing the object type description.  <a href="#c7d46e5f565c97b0250fe837f985e283"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="vocSesame_8c.html#4526ce29541bc2a1b4c939c494c6d00e">voc_resolverRA</a> (Sesame sr)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the RA as a double precision value.  <a href="#4526ce29541bc2a1b4c939c494c6d00e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="vocSesame_8c.html#4fe9b855c8e4cca0f1fdced36d5ae8ea">voc_resolverRAErr</a> (Sesame sr)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the RA error as a double precision value.  <a href="#4fe9b855c8e4cca0f1fdced36d5ae8ea"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="vocSesame_8c.html#46c25290911c3217bdc4294eded2ba46">voc_resolverDEC</a> (Sesame sr)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the DEC as a double precision value.  <a href="#46c25290911c3217bdc4294eded2ba46"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="vocSesame_8c.html#f0fb68ddb8bd62c72e21de2bed525b4c">voc_resolverDECErr</a> (Sesame sr)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the Dec error as a double precision value.  <a href="#f0fb68ddb8bd62c72e21de2bed525b4c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5383de2a3bf7243d0ac205fc0faa6785"></a><!-- doxytag: member="vocSesame.c::voc_getCacheDir" ref="5383de2a3bf7243d0ac205fc0faa6785" args="(char *subdir)" -->
char *&nbsp;</td><td class="memItemRight" valign="bottom"><b>voc_getCacheDir</b> (char *subdir)</td></tr>

<tr><td colspan="2"><br><h2>Variables</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1d587466a412b72dd4432e473f0fb60e"></a><!-- doxytag: member="vocSesame.c::clientCache" ref="1d587466a412b72dd4432e473f0fb60e" args="[MAX_OBJECTS]" -->
<a class="el" href="structObject.html">Object</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>clientCache</b> [MAX_OBJECTS]</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d8d847f1b70d0e2bc3da7e990ff0d317"></a><!-- doxytag: member="vocSesame.c::cacheTop" ref="d8d847f1b70d0e2bc3da7e990ff0d317" args="" -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><b>cacheTop</b> = 0</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e8b9013ac3d6a8f93991444d8c8c5919"></a><!-- doxytag: member="vocSesame.c::vo" ref="e8b9013ac3d6a8f93991444d8c8c5919" args="" -->
VOClient *&nbsp;</td><td class="memItemRight" valign="bottom"><b>vo</b></td></tr>

</table>
<hr><h2>Detailed Description</h2>
VOCSESAME.C -- Interface to the Sesame name resolver service.<h2><a class="anchor" name="DESCRIPTION">
DESCRIPTION</a></h2>
Sesame Name Resolver Interface: -------------------------------<p>
sr = voc_nameResolver (target) pos_str = voc_resolverPos (sr) radeg = voc_resolverRA (sr) decdeg = voc_resolverDEC (sr) ra_err = voc_resolverRAErr (sr) dec_err = voc_resolverDECErr (sr) typ_str = voc_resolverOtype (sr)<p>
Client programs may be written in any language that can interface to C code. Sample programs using the interface are provided as is a SWIG interface definition file. This inferface is based closely on the DAL client code produced for the 2005 NVOSS, as that interface evolves<p>
<dl class="author" compact><dt><b>Author:</b></dt><dd>Michael Fitzpatrick </dd></dl>
<dl class="version" compact><dt><b>Version:</b></dt><dd>June 2006 </dd></dl>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="467c02f32e92e6808b6d1c129b8d5b04"></a><!-- doxytag: member="vocSesame.c::voc_nameResolver" ref="467c02f32e92e6808b6d1c129b8d5b04" args="(char *target)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Sesame voc_nameResolver           </td>
          <td>(</td>
          <td class="paramtype">char *&nbsp;</td>
          <td class="paramname"> <em>target</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Query the CDS Sesame name resolver service. 
<p>
NAMERESOLVER -- Query the CDS Sesame service to resolve the target name to coordinates. The query is done when creating the Sesame object, thereafter we simply query the object data.<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>target</em>&nbsp;</td><td>name of target to be resolved </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Sesame Sesame object handle </dd></dl>

</div>
</div><p>
<a class="anchor" name="46c25290911c3217bdc4294eded2ba46"></a><!-- doxytag: member="vocSesame.c::voc_resolverDEC" ref="46c25290911c3217bdc4294eded2ba46" args="(Sesame sr)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double voc_resolverDEC           </td>
          <td>(</td>
          <td class="paramtype">Sesame&nbsp;</td>
          <td class="paramname"> <em>sr</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Return the DEC as a double precision value. 
<p>
RESOLVERDEC -- Return the DEC as a double precision value.<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>sr</em>&nbsp;</td><td>handle to previus query return </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>object Declination (decimal degrees) </dd></dl>

</div>
</div><p>
<a class="anchor" name="f0fb68ddb8bd62c72e21de2bed525b4c"></a><!-- doxytag: member="vocSesame.c::voc_resolverDECErr" ref="f0fb68ddb8bd62c72e21de2bed525b4c" args="(Sesame sr)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double voc_resolverDECErr           </td>
          <td>(</td>
          <td class="paramtype">Sesame&nbsp;</td>
          <td class="paramname"> <em>sr</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Return the Dec error as a double precision value. 
<p>
RESOLVERDECERR -- Return the Dec error as a double precision value.<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>sr</em>&nbsp;</td><td>handle to previus query return </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>object DEC error (decimal degrees) </dd></dl>

</div>
</div><p>
<a class="anchor" name="c7d46e5f565c97b0250fe837f985e283"></a><!-- doxytag: member="vocSesame.c::voc_resolverOtype" ref="c7d46e5f565c97b0250fe837f985e283" args="(Sesame sr)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">char* voc_resolverOtype           </td>
          <td>(</td>
          <td class="paramtype">Sesame&nbsp;</td>
          <td class="paramname"> <em>sr</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Return a string containing the object type description. 
<p>
RESOLVEROTYPE -- Return a string containing the object type description<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>sr</em>&nbsp;</td><td>handle to previus query return </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>string to object type description </dd></dl>

</div>
</div><p>
<a class="anchor" name="911355789d941847843c8d42ad00314a"></a><!-- doxytag: member="vocSesame.c::voc_resolverPos" ref="911355789d941847843c8d42ad00314a" args="(Sesame sr)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">char* voc_resolverPos           </td>
          <td>(</td>
          <td class="paramtype">Sesame&nbsp;</td>
          <td class="paramname"> <em>sr</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Return the (ra,dec) position for the object. 
<p>
RESOLVERPOS -- Return a string containing the (ra,dec) position as sexagesimal strings.<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>sr</em>&nbsp;</td><td>handle to previus query return </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>string containing (ra,dec) position </dd></dl>

</div>
</div><p>
<a class="anchor" name="4526ce29541bc2a1b4c939c494c6d00e"></a><!-- doxytag: member="vocSesame.c::voc_resolverRA" ref="4526ce29541bc2a1b4c939c494c6d00e" args="(Sesame sr)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double voc_resolverRA           </td>
          <td>(</td>
          <td class="paramtype">Sesame&nbsp;</td>
          <td class="paramname"> <em>sr</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Return the RA as a double precision value. 
<p>
RESOLVERRA -- Return the RA as a double precision value.<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>sr</em>&nbsp;</td><td>handle to previus query return </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>object RA (decimal degrees) </dd></dl>

</div>
</div><p>
<a class="anchor" name="4fe9b855c8e4cca0f1fdced36d5ae8ea"></a><!-- doxytag: member="vocSesame.c::voc_resolverRAErr" ref="4fe9b855c8e4cca0f1fdced36d5ae8ea" args="(Sesame sr)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double voc_resolverRAErr           </td>
          <td>(</td>
          <td class="paramtype">Sesame&nbsp;</td>
          <td class="paramname"> <em>sr</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Return the RA error as a double precision value. 
<p>
RESOLVERRAERR -- Return the RA error as a double precision value.<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>sr</em>&nbsp;</td><td>handle to previus query return </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>object RA error (decimal degrees) </dd></dl>

</div>
</div><p>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Feb 27 21:08:58 2013 for VOClient API by&nbsp;
<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>