path: root/vendor/voclient/libvoclient/doc/latex/vocSesame_8c.tex

hypertarget{vocSesame_8c}{
\section{vocSesame.c File Reference}
\label{vocSesame_8c}\index{vocSesame.c@{vocSesame.c}}
}
{\tt \#include $<$stdio.h$>$}\par
{\tt \#include $<$stdlib.h$>$}\par
{\tt \#include $<$unistd.h$>$}\par
{\tt \#include $<$signal.h$>$}\par
{\tt \#include $<$errno.h$>$}\par
{\tt \#include $<$sys/types.h$>$}\par
{\tt \#include $<$sys/stat.h$>$}\par
{\tt \#include $<$dirent.h$>$}\par
{\tt \#include \char`\"{}VOClient.h\char`\"{}}\par
\subsection*{Classes}
\begin{CompactItemize}
\item 
struct \hyperlink{structObject}{Object}
\end{CompactItemize}
\subsection*{Defines}
\begin{CompactItemize}
\item 
\hypertarget{vocSesame_8c_96522681f45fae55d1e17bcb63620e45}{
\#define \textbf{\_\-VOCLIENT\_\-LIB\_\-}}
\label{vocSesame_8c_96522681f45fae55d1e17bcb63620e45}

\item 
\hypertarget{vocSesame_8c_cdc7844fbd4d45737d4aa56834d37829}{
\#define \textbf{MAX\_\-OBJECTS}~128}
\label{vocSesame_8c_cdc7844fbd4d45737d4aa56834d37829}

\item 
\hypertarget{vocSesame_8c_2e97c1de9ed6a4c34b8731fed4b2e624}{
\#define \textbf{SZ\_\-TARGET}~128}
\label{vocSesame_8c_2e97c1de9ed6a4c34b8731fed4b2e624}

\end{CompactItemize}
\subsection*{Typedefs}
\begin{CompactItemize}
\item 
\hypertarget{vocSesame_8c_867c408546a8562a552a59405804f607}{
typedef struct \hyperlink{structObject}{Object} $\ast$ \textbf{ObjectPtr}}
\label{vocSesame_8c_867c408546a8562a552a59405804f607}

\end{CompactItemize}
\subsection*{Functions}
\begin{CompactItemize}
\item 
Sesame \hyperlink{vocSesame_8c_467c02f32e92e6808b6d1c129b8d5b04}{voc\_\-nameResolver} (char $\ast$target)
\begin{CompactList}\small\item\em Query the CDS Sesame name resolver service. \item\end{CompactList}\item 
char $\ast$ \hyperlink{vocSesame_8c_911355789d941847843c8d42ad00314a}{voc\_\-resolverPos} (Sesame sr)
\begin{CompactList}\small\item\em Return the (ra,dec) position for the object. \item\end{CompactList}\item 
char $\ast$ \hyperlink{vocSesame_8c_c7d46e5f565c97b0250fe837f985e283}{voc\_\-resolverOtype} (Sesame sr)
\begin{CompactList}\small\item\em Return a string containing the object type description. \item\end{CompactList}\item 
double \hyperlink{vocSesame_8c_4526ce29541bc2a1b4c939c494c6d00e}{voc\_\-resolverRA} (Sesame sr)
\begin{CompactList}\small\item\em Return the RA as a double precision value. \item\end{CompactList}\item 
double \hyperlink{vocSesame_8c_4fe9b855c8e4cca0f1fdced36d5ae8ea}{voc\_\-resolverRAErr} (Sesame sr)
\begin{CompactList}\small\item\em Return the RA error as a double precision value. \item\end{CompactList}\item 
double \hyperlink{vocSesame_8c_46c25290911c3217bdc4294eded2ba46}{voc\_\-resolverDEC} (Sesame sr)
\begin{CompactList}\small\item\em Return the DEC as a double precision value. \item\end{CompactList}\item 
double \hyperlink{vocSesame_8c_f0fb68ddb8bd62c72e21de2bed525b4c}{voc\_\-resolverDECErr} (Sesame sr)
\begin{CompactList}\small\item\em Return the Dec error as a double precision value. \item\end{CompactList}\item 
\hypertarget{vocSesame_8c_5383de2a3bf7243d0ac205fc0faa6785}{
char $\ast$ \textbf{voc\_\-getCacheDir} (char $\ast$subdir)}
\label{vocSesame_8c_5383de2a3bf7243d0ac205fc0faa6785}

\end{CompactItemize}
\subsection*{Variables}
\begin{CompactItemize}
\item 
\hypertarget{vocSesame_8c_1d587466a412b72dd4432e473f0fb60e}{
\hyperlink{structObject}{Object} \textbf{clientCache} \mbox{[}MAX\_\-OBJECTS\mbox{]}}
\label{vocSesame_8c_1d587466a412b72dd4432e473f0fb60e}

\item 
\hypertarget{vocSesame_8c_d8d847f1b70d0e2bc3da7e990ff0d317}{
int \textbf{cacheTop} = 0}
\label{vocSesame_8c_d8d847f1b70d0e2bc3da7e990ff0d317}

\item 
\hypertarget{vocSesame_8c_e8b9013ac3d6a8f93991444d8c8c5919}{
VOClient $\ast$ \textbf{vo}}
\label{vocSesame_8c_e8b9013ac3d6a8f93991444d8c8c5919}

\end{CompactItemize}


\label{_details}
\hypertarget{_details}{}
\subsection{Detailed Description}
VOCSESAME.C -- Interface to the Sesame name resolver service.\hypertarget{vocSesame__spp_8c_DESCRIPTION}{}\subsection{DESCRIPTION}\label{vocSesame__spp_8c_DESCRIPTION}
Sesame Name Resolver Interface: -------------------------------

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)

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

\begin{Desc}
\item[Author:]Michael Fitzpatrick \end{Desc}
\begin{Desc}
\item[Version:]June 2006 \end{Desc}


\subsection{Function Documentation}
\hypertarget{vocSesame_8c_467c02f32e92e6808b6d1c129b8d5b04}{
\index{vocSesame.c@{vocSesame.c}!voc\_\-nameResolver@{voc\_\-nameResolver}}
\index{voc\_\-nameResolver@{voc\_\-nameResolver}!vocSesame.c@{vocSesame.c}}
\subsubsection[{voc\_\-nameResolver}]{\setlength{\rightskip}{0pt plus 5cm}Sesame voc\_\-nameResolver (char $\ast$ {\em target})}}
\label{vocSesame_8c_467c02f32e92e6808b6d1c129b8d5b04}


Query the CDS Sesame name resolver service. 

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.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em target}]name of target to be resolved \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]Sesame Sesame object handle \end{Desc}
\hypertarget{vocSesame_8c_46c25290911c3217bdc4294eded2ba46}{
\index{vocSesame.c@{vocSesame.c}!voc\_\-resolverDEC@{voc\_\-resolverDEC}}
\index{voc\_\-resolverDEC@{voc\_\-resolverDEC}!vocSesame.c@{vocSesame.c}}
\subsubsection[{voc\_\-resolverDEC}]{\setlength{\rightskip}{0pt plus 5cm}double voc\_\-resolverDEC (Sesame {\em sr})}}
\label{vocSesame_8c_46c25290911c3217bdc4294eded2ba46}


Return the DEC as a double precision value. 

RESOLVERDEC -- Return the DEC as a double precision value.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em sr}]handle to previus query return \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]object Declination (decimal degrees) \end{Desc}
\hypertarget{vocSesame_8c_f0fb68ddb8bd62c72e21de2bed525b4c}{
\index{vocSesame.c@{vocSesame.c}!voc\_\-resolverDECErr@{voc\_\-resolverDECErr}}
\index{voc\_\-resolverDECErr@{voc\_\-resolverDECErr}!vocSesame.c@{vocSesame.c}}
\subsubsection[{voc\_\-resolverDECErr}]{\setlength{\rightskip}{0pt plus 5cm}double voc\_\-resolverDECErr (Sesame {\em sr})}}
\label{vocSesame_8c_f0fb68ddb8bd62c72e21de2bed525b4c}


Return the Dec error as a double precision value. 

RESOLVERDECERR -- Return the Dec error as a double precision value.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em sr}]handle to previus query return \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]object DEC error (decimal degrees) \end{Desc}
\hypertarget{vocSesame_8c_c7d46e5f565c97b0250fe837f985e283}{
\index{vocSesame.c@{vocSesame.c}!voc\_\-resolverOtype@{voc\_\-resolverOtype}}
\index{voc\_\-resolverOtype@{voc\_\-resolverOtype}!vocSesame.c@{vocSesame.c}}
\subsubsection[{voc\_\-resolverOtype}]{\setlength{\rightskip}{0pt plus 5cm}char$\ast$ voc\_\-resolverOtype (Sesame {\em sr})}}
\label{vocSesame_8c_c7d46e5f565c97b0250fe837f985e283}


Return a string containing the object type description. 

RESOLVEROTYPE -- Return a string containing the object type description

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em sr}]handle to previus query return \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]string to object type description \end{Desc}
\hypertarget{vocSesame_8c_911355789d941847843c8d42ad00314a}{
\index{vocSesame.c@{vocSesame.c}!voc\_\-resolverPos@{voc\_\-resolverPos}}
\index{voc\_\-resolverPos@{voc\_\-resolverPos}!vocSesame.c@{vocSesame.c}}
\subsubsection[{voc\_\-resolverPos}]{\setlength{\rightskip}{0pt plus 5cm}char$\ast$ voc\_\-resolverPos (Sesame {\em sr})}}
\label{vocSesame_8c_911355789d941847843c8d42ad00314a}


Return the (ra,dec) position for the object. 

RESOLVERPOS -- Return a string containing the (ra,dec) position as sexagesimal strings.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em sr}]handle to previus query return \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]string containing (ra,dec) position \end{Desc}
\hypertarget{vocSesame_8c_4526ce29541bc2a1b4c939c494c6d00e}{
\index{vocSesame.c@{vocSesame.c}!voc\_\-resolverRA@{voc\_\-resolverRA}}
\index{voc\_\-resolverRA@{voc\_\-resolverRA}!vocSesame.c@{vocSesame.c}}
\subsubsection[{voc\_\-resolverRA}]{\setlength{\rightskip}{0pt plus 5cm}double voc\_\-resolverRA (Sesame {\em sr})}}
\label{vocSesame_8c_4526ce29541bc2a1b4c939c494c6d00e}


Return the RA as a double precision value. 

RESOLVERRA -- Return the RA as a double precision value.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em sr}]handle to previus query return \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]object RA (decimal degrees) \end{Desc}
\hypertarget{vocSesame_8c_4fe9b855c8e4cca0f1fdced36d5ae8ea}{
\index{vocSesame.c@{vocSesame.c}!voc\_\-resolverRAErr@{voc\_\-resolverRAErr}}
\index{voc\_\-resolverRAErr@{voc\_\-resolverRAErr}!vocSesame.c@{vocSesame.c}}
\subsubsection[{voc\_\-resolverRAErr}]{\setlength{\rightskip}{0pt plus 5cm}double voc\_\-resolverRAErr (Sesame {\em sr})}}
\label{vocSesame_8c_4fe9b855c8e4cca0f1fdced36d5ae8ea}


Return the RA error as a double precision value. 

RESOLVERRAERR -- Return the RA error as a double precision value.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em sr}]handle to previus query return \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]object RA error (decimal degrees) \end{Desc}