votParse.c File Reference

Public interface procedures for the libVOTable parser. More...

#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <expat.h>
#include <unistd.h>
#include <assert.h>
#include <ctype.h>
#include <sys/stat.h>
#include <curl/curl.h>
#include <curl/types.h>
#include <curl/easy.h>
#include "votParseP.h"
#include "votParse.h"

Defines

#define BUFSIZE   4096

Functions

handle_t vot_openVOTABLE (char *arg)
 Parse a VOTable and return a handle to it.
void vot_closeVOTABLE (handle_t vot)
 Destroy the root node and all of it's children.
handle_t vot_getRESOURCE (handle_t handle)
 Gets the RESOURCE node from the parent handle.
handle_t vot_getTABLE (handle_t handle)
 Gets the TABLE node from the parent handle.
handle_t vot_getFIELD (handle_t handle)
 Gets the FIELD node from the parent handle.
handle_t vot_getDATA (handle_t handle)
 Gets the DATA node from the parent handle.
handle_t vot_getTABLEDATA (handle_t handle)
 Gets the TABLEDATA node from the parent handle.
handle_t vot_getTR (handle_t handle)
 Gets the TR node from the parent handle.
handle_t vot_getTD (handle_t handle)
 Gets the TD node from the parent handle.
handle_t vot_getBINARY (handle_t handle)
 Gets the BINARY node from the parent handle.
handle_t vot_getBINARY2 (handle_t handle)
 Gets the BINARY2 node from the parent handle.
handle_t vot_getFITS (handle_t handle)
 Gets the FITS node from the parent handle.
handle_t vot_getGROUP (handle_t handle)
 Gets the GROUP node from the parent handle.
handle_t vot_getFIELDRef (handle_t handle)
 Gets the FIELDref node from the parent handle.
handle_t vot_getPARAMRef (handle_t handle)
 Gets the PARAMRef node from the parent handle.
handle_t vot_getDESCRIPTION (handle_t handle)
 Gets the DESCRIPTION node from the parent handle.
handle_t vot_getPARAM (handle_t handle)
 Gets the PARAM node from the parent handle.
handle_t vot_getINFO (handle_t handle)
 Gets the INFO node from the parent handle.
handle_t vot_getSTREAM (handle_t handle)
 Gets the STREAM node from the parent handle.
handle_t vot_getVALUES (handle_t handle)
 Gets the VALUES node from the parent handle.
handle_t vot_getMIN (handle_t handle)
 Gets the MIN node from the parent handle.
handle_t vot_getMAX (handle_t handle)
 Gets the MAX node from the parent handle.
handle_t vot_getOPTION (handle_t handle)
 Gets the OPTION node from the parent handle.
handle_t vot_getLINK (handle_t handle)
 Gets the LINK node from the parent handle.
handle_t vot_getCOOSYS (handle_t handle)
 Gets the COOSYS node from the parent handle.
int vot_getDATAType (handle_t data_h)
 Returns the type of the DATA element.
char * vot_getDATATypeString (handle_t data_h)
 Returns the type of the DATA element as a string.
handle_t vot_newRESOURCE (handle_t parent_h)
 Create new RESOURCE node under the parent handle.
handle_t vot_newTABLE (handle_t parent_h)
 Create new TABLE node under the parent handle.
handle_t vot_newFIELD (handle_t parent_h)
 Create new FIELD node under the parent handle.
handle_t vot_newDATA (handle_t parent_h)
 Create new DATA node under the parent handle.
handle_t vot_newTABLEDATA (handle_t parent_h)
 Create new TABLEDATA node under the parent handle.
handle_t vot_newTR (handle_t parent_h)
 Create new TR node under the parent handle.
handle_t vot_newTD (handle_t parent_h)
 Create new TD node under the parent handle.
handle_t vot_newBINARY (handle_t parent_h)
 Create new BINARY node under the parent handle.
handle_t vot_newBINARY2 (handle_t parent_h)
 Create new BINARY2 node under the parent handle.
handle_t vot_newFITS (handle_t parent_h)
 Create new FITS node under the parent handle.
handle_t vot_newGROUP (handle_t parent_h)
 Create new GROUP node under the parent handle.
handle_t vot_newFIELDRef (handle_t parent_h)
 Create new FIELDref node under the parent handle.
handle_t vot_newPARAMRef (handle_t parent_h)
 Create new PARAMRef node under the parent handle.
handle_t vot_newDESCRIPTION (handle_t parent_h)
 Create new DESCRIPTION node under the parent handle.
handle_t vot_newPARAM (handle_t parent_h)
 Create new PARAM node under the parent handle.
handle_t vot_newINFO (handle_t parent_h)
 Create new INFO node under the parent handle.
handle_t vot_newSTREAM (handle_t parent_h)
 Create new STREAM node under the parent handle.
handle_t vot_newVALUES (handle_t parent_h)
 Create new VALUES node under the parent handle.
handle_t vot_newMIN (handle_t parent_h)
 Create new MIN node under the parent handle.
handle_t vot_newMAX (handle_t parent_h)
 Create new MAX node under the parent handle.
handle_t vot_newOPTION (handle_t parent_h)
 Create new OPTION node under the parent handle.
handle_t vot_newLINK (handle_t parent_h)
 Create new LINK node under the parent handle.
handle_t vot_newCOOSYS (handle_t parent_h)
 Create new COOSYS node under the parent handle.
handle_t vot_newNode (handle_t parent, int type)
 Creates a new blank unlinked node.
void vot_attachNode (handle_t parent, handle_t new)
 Adds a node as a child of parent.
void vot_freeNode (handle_t node)
 Destroys the node and all of it's children.
void vot_deleteNode (handle_t element)
 Destroys the node and all of it's children.
handle_t vot_copyElement (handle_t src_h, handle_t parent_h)
 Adds a node as a child of parent.
int vot_getNCols (handle_t tdata_h)
 Return the nuber of columns in the table structure.
int vot_getNRows (handle_t tdata_h)
 Return the nuber of columns in the table structure.
char * vot_getTableCell (handle_t tdata_h, int row, int col)
 Return the nuber of columns in the structure.
int vot_tableCompare (const void *row1, const void *row2)
int vot_sortTable (handle_t tdata_h, int col, int strsort, int order)
int vot_getLength (handle_t elem_h)
 Return the number of sibling Elements of the same type.
int vot_getNumberOf (handle_t elem_h, int type)
 Return the number of sibling Elements of the type.
int vot_colByAttr (int tab, char *attr, char *name, char *alt)
int vot_colByName (int tab, char *name, char *alt)
int vot_colByUCD (int tab, char *name, char *alt)
int vot_colByID (int tab, char *name, char *alt)
handle_t vot_findByAttr (handle_t parent, char *name, char *value)
 Get a handle to an Element with the requested attribute.
handle_t * vot_findInGroup (handle_t group, int type)
 Return a handle array of the requested Element type.
handle_t vot_getNext (handle_t elem_h)
 Return a handle_t of the next Element of the same type.
handle_t vot_getSibling (handle_t elem_h)
 Return a handle_t of the next Element.
handle_t vot_getChild (handle_t elem_h)
 Return a handle_t of the child Element.
handle_t vot_getParent (handle_t elem_h)
 Return the handle of the parent Element.
handle_t vot_getChildOfType (handle_t elem_h, int type)
 Get the handle of the next Element of the same type.
int vot_valueOf (handle_t elem_h)
 Return type of the Element.
int vot_typeOf (handle_t elem_h)
 Return type of the Element.
int vot_setValue (handle_t elem_h, char *value)
 Set the Value for the ELEMENT.
char * vot_getValue (handle_t elem_h)
 Get the Value for the ELEMENT.
int vot_setAttr (handle_t elem_h, char *attr, char *value)
 Set the attribute for the Element.
char * vot_getAttr (handle_t elem_h, char *attr)
 Return the attribute for the Element.
void vot_writeVOTable (handle_t node, char *fname, int indent)
 Write the VOTable to the file descriptor.
void vot_writeHTML (handle_t node, char *ifname, char *ofname)
 Write the VOTable to the file descriptor as HTML.
void vot_writeSHTML (handle_t node, char *ifname, char *ofname)
 Write the VOTable to the file descriptor as an HTML table.
void vot_writeFITS (handle_t node, char *fname)
 Write the VOTable to the file descriptor as an FITS table.
void vot_writeDelimited (handle_t vot, char *fname, char delim, int hdr)
void vot_writeASV (handle_t node, char *fname, int header)
 Write the VOTable to the file descriptor as a ASV file.
void vot_writeBSV (handle_t node, char *fname, int header)
 Write the VOTable to the file descriptor as a BSV file.
void vot_writeCSV (handle_t node, char *fname, int header)
 Write the VOTable to the file descriptor as a CSV file.
void vot_writeTSV (handle_t node, char *fname, int header)
 Write the VOTable to the file descriptor as a TSV file.
void vot_setWarnings (int value)
 Set the warning level.
void votEmsg (char *msg)

Variables

Stack * element_stack = NULL
Element * vot_struct = NULL
char * votELevel = ""
int votWarn = 0
struct {
   int   type
   int   parents
   int   children
} elemParents []

Detailed Description

Public interface procedures for the libVOTable parser.

VOTPARSE.C -- Public interface procedures for the libVOTable parser.

Author:
Mike Fitzpatrick and Eric Timmermann
Date:
8/03/09

Function Documentation

vot_attachNode ( handle_t  parent,
handle_t  new 
)

Adds a node as a child of parent.

vot_attachNode -- Adds a node as a child of parent.

Parameters:
parent A handle to the Element that you want to add a node to
new A handle to the Element that you want to add
Returns:
nothing

vot_closeVOTABLE ( handle_t  vot  ) 

Destroy the root node and all of it's children.

vot_closeVOTABLE -- Destroy the root node and all of it's children.

Parameters:
vot A handle to the Element that you want deleted
Returns:
nothing
Warning:
Destroys the node and all of it's children.

handle_t vot_copyElement ( handle_t  src_h,
handle_t  parent_h 
)

Adds a node as a child of parent.

vot_copyElement -- Adds a node as a child of parent.

Parameters:
src_h A handle to the Element to copy
parent_h A handle to the Elements parent
Returns:
A handle_t of the copy of the structure

vot_deleteNode ( handle_t  element  ) 

Destroys the node and all of it's children.

vot_deleteNode -- Destroys the node and all of it's children.

Parameters:
element A handle to the Element that you want deleted
Returns:
nothing

handle_t vot_findByAttr ( handle_t  parent,
char *  name,
char *  value 
)

Get a handle to an Element with the requested attribute.

vot_findByAttr -- Get a handle to an Element with the requested attribute.

Parameters:
parent A handle_t the parent Element
name A string holding the Value type
value A string holding the Value value
Returns:
The handle to the element

handle_t * vot_findInGroup ( handle_t  group,
int  type 
)

Return a handle array of the requested Element type.

vot_findInGroup -- Return a handle array of the requested Element type.

Parameters:
group A handle_t the parent Element
type Value of the type
Returns:
An array of handles

vot_freeNode ( handle_t  node  ) 

Destroys the node and all of it's children.

vot_freeNode -- Destroys the node and all of it's children.

Parameters:
node A handle to the Element that you want deleted
Returns:
nothing

char * vot_getAttr ( handle_t  elem_h,
char *  attr 
)

Return the attribute for the Element.

vot_getAttr -- Return the attribute for the Element.

Parameters:
elem_h A handle_t the Element
attr A string holding the attribute name
Returns:
A string of the value or the attr

handle_t vot_getBINARY ( handle_t  handle  ) 

Gets the BINARY node from the parent handle.

vot_getBINARY -- Gets the BINARY node from the parent handle

Parameters:
handle Parent handle containing a BINARY
Returns:
A handle to the first BINARY node, or zero

handle_t vot_getBINARY2 ( handle_t  handle  ) 

Gets the BINARY2 node from the parent handle.

vot_getBINARY2 -- Gets the BINARY2 node from the parent handle

Parameters:
handle Parent handle containing a BINARY2
Returns:
A handle to the first BINARY2 node, or zero

handle_t vot_getChild ( handle_t  elem_h  ) 

Return a handle_t of the child Element.

vot_getChild -- Return a handle_t of the child Element.

Parameters:
elem_h A handle_t the Element
Returns:
A handle of the child Element

handle_t vot_getChildOfType ( handle_t  elem_h,
int  type 
)

Get the handle of the next Element of the same type.

vot_getChildOfType -- Get the handle of the next Element of the same type.

Parameters:
elem_h A handle_t the Element
type An integer of the Element type for find
Returns:
A handle of the Element

handle_t vot_getCOOSYS ( handle_t  handle  ) 

Gets the COOSYS node from the parent handle.

vot_getCOOSYS -- Gets the COOSYS node from the parent handle

Parameters:
handle Parent handle containing a COOSYS
Returns:
A handle to the first COOSYS node, or zero

handle_t vot_getDATA ( handle_t  handle  ) 

Gets the DATA node from the parent handle.

vot_getDATA -- Gets the DATA node from the parent handle

Parameters:
handle Parent handle containing a DATA
Returns:
A handle to the first DATA node, or zero

char * vot_getDATAType ( handle_t  data_h  ) 

Returns the type of the DATA element.

vot_getDATAType -- Returns the type of the DATA element.

Parameters:
data_h A handle_t to a DATA
Returns:
The type as an int

char * vot_getDATATypeString ( handle_t  data_h  ) 

Returns the type of the DATA element as a string.

vot_getDATATypeString -- Returns the type of the DATA element as a string.

Parameters:
data_h A handle_t to a DATA
Returns:
The type as an string

handle_t vot_getDESCRIPTION ( handle_t  handle  ) 

Gets the DESCRIPTION node from the parent handle.

vot_getDESCRIPTION -- Gets the DESCRIPTION node from the parent handle

Parameters:
handle Parent handle containing a DESCRIPTION
Returns:
A handle to the first DESCRIPTION node, or zero

handle_t vot_getFIELD ( handle_t  handle  ) 

Gets the FIELD node from the parent handle.

vot_getFIELD -- Gets the FIELD node from the parent handle

Parameters:
handle Parent handle containing a FIELD
Returns:
A handle to the first FIELD node, or zero

handle_t vot_getFIELDRef ( handle_t  handle  ) 

Gets the FIELDref node from the parent handle.

vot_getFIELDref -- Gets the FIELDref node from the parent handle

Parameters:
handle Parent handle containing a FIELDref
Returns:
A handle to the first FIELDref node, or zero

handle_t vot_getFITS ( handle_t  handle  ) 

Gets the FITS node from the parent handle.

vot_getFITS -- Gets the FITS node from the parent handle

Parameters:
handle Parent handle containing a FITS
Returns:
A handle to the first FITS node, or zero

handle_t vot_getGROUP ( handle_t  handle  ) 

Gets the GROUP node from the parent handle.

vot_getGROUP -- Gets the GROUP node from the parent handle

Parameters:
handle Parent handle containing a GROUP
Returns:
A handle to the first GROUP node, or zero

handle_t vot_getINFO ( handle_t  handle  ) 

Gets the INFO node from the parent handle.

vot_getINFO -- Gets the INFO node from the parent handle

Parameters:
handle Parent handle containing a INFO
Returns:
A handle to the first INFO node, or zero

int vot_getLength ( handle_t  elem_h  ) 

Return the number of sibling Elements of the same type.

vot_getLength -- Return the number of sibling Elements of the same type.

Parameters:
elem_h A handle_t the Element
Returns:
The status of the set

handle_t vot_getLINK ( handle_t  handle  ) 

Gets the LINK node from the parent handle.

vot_getLINK -- Gets the LINK node from the parent handle

Parameters:
handle Parent handle containing a LINK
Returns:
A handle to the first LINK node, or zero

handle_t vot_getMAX ( handle_t  handle  ) 

Gets the MAX node from the parent handle.

vot_getMAX -- Gets the MAX node from the parent handle

Parameters:
handle Parent handle containing a MAX
Returns:
A handle to the first MAX node, or zero

handle_t vot_getMIN ( handle_t  handle  ) 

Gets the MIN node from the parent handle.

vot_getMIN -- Gets the MIN node from the parent handle

Parameters:
handle Parent handle containing a MIN
Returns:
A handle to the first MIN node, or zero

int vot_getNCols ( handle_t  tdata_h  ) 

Return the nuber of columns in the table structure.

************************************************************************** Utility methods vot_getNCols -- Return the nuber of columns in the table structure.

Parameters:
tdata_h A handle_t to a TABLEDATA
Returns:
The number of cols

handle_t vot_getNext ( handle_t  elem_h  ) 

Return a handle_t of the next Element of the same type.

vot_getNext -- Return a handle_t of the next Element of the same type.

Parameters:
elem_h A handle_t the Element
Returns:
A handle of the next Element of the same type

int vot_getNRows ( handle_t  tdata_h  ) 

Return the nuber of columns in the table structure.

vot_getNRows -- Return the nuber of columns in the table structure.

Parameters:
tdata_h A handle_t to a TABLEDATA
Returns:
The number of cols

int vot_getNumberOf ( handle_t  elem_h,
int  type 
)

Return the number of sibling Elements of the type.

vot_getNumberOf -- Return the number of sibling Elements of the type.

Parameters:
elem_h A handle_t the Element
type An int of the type of element you wish to count
Returns:
The status of the set

handle_t vot_getOPTION ( handle_t  handle  ) 

Gets the OPTION node from the parent handle.

vot_getOPTION -- Gets the OPTION node from the parent handle

Parameters:
handle Parent handle containing a OPTION
Returns:
A handle to the first OPTION node, or zero

handle_t vot_getPARAM ( handle_t  handle  ) 

Gets the PARAM node from the parent handle.

vot_getPARAM -- Gets the PARAM node from the parent handle

Parameters:
handle Parent handle containing a PARAM
Returns:
A handle to the first PARAM node, or zero

handle_t vot_getPARAMRef ( handle_t  handle  ) 

Gets the PARAMRef node from the parent handle.

vot_getPARAMRef -- Gets the PARAMref node from the parent handle

Parameters:
handle Parent handle containing a PARAMRef
Returns:
A handle to the first PARAMRef node, or zero

handle_t vot_getParent ( handle_t  elem_h  ) 

Return the handle of the parent Element.

vot_getParent -- Return the handle of the parent Element.

Parameters:
elem_h A handle_t the Element
Returns:
A handle of the paretn Element

handle_t vot_getRESOURCE ( handle_t  handle  ) 

Gets the RESOURCE node from the parent handle.

vot_getRESOURCE -- Gets the RESOURCE node from the parent handle

Parameters:
handle Parent handle containing a RESOURCE
Returns:
A handle to the first RESOURCE node, or zero

handle_t vot_getSibling ( handle_t  elem_h  ) 

Return a handle_t of the next Element.

vot_getSibling -- Return a handle_t of the next signling Element.

Parameters:
elem_h A handle_t the Element
Returns:
A handle of the next Element

handle_t vot_getSTREAM ( handle_t  handle  ) 

Gets the STREAM node from the parent handle.

vot_getSTREAM -- Gets the STREAM node from the parent handle

Parameters:
handle Parent handle containing a STREAM
Returns:
A handle to the first STREAM node, or zero

handle_t vot_getTABLE ( handle_t  handle  ) 

Gets the TABLE node from the parent handle.

vot_getTABLE -- Gets the TABLE node from the parent handle

Parameters:
handle Parent handle containing a TABLE
Returns:
A handle to the first TABLE node, or zero

char * vot_getTableCell ( handle_t  tdata_h,
int  row,
int  col 
)

Return the nuber of columns in the structure.

vot_getTableCell -- Return the nuber of columns in the structure.

Parameters:
tdata_h A handle_t to a TABLEDATA
row An int for a row
col An int for a col
Returns:
The content of the cell

handle_t vot_getTABLEDATA ( handle_t  handle  ) 

Gets the TABLEDATA node from the parent handle.

vot_getTABLEDATA -- Gets the TABLEDATA node from the parent handle

Parameters:
handle Parent handle containing a TABLEDATA
Returns:
A handle to the first TABLEDATA node, or zero

handle_t vot_getTD ( handle_t  handle  ) 

Gets the TD node from the parent handle.

vot_getTD -- Gets the TD node from the parent handle

Parameters:
handle Parent handle containing a TD
Returns:
A handle to the first TD node, or zero

handle_t vot_getTR ( handle_t  handle  ) 

Gets the TR node from the parent handle.

vot_getTR -- Gets the TR node from the parent handle

Parameters:
handle Parent handle containing a TR
Returns:
A handle to the first TR node, or zero

char * vot_getValue ( handle_t  elem_h  ) 

Get the Value for the ELEMENT.

vot_getValue -- Get the Value for the ELEMENT.

Parameters:
elem_h A handle_t the ELEMENT
Returns:
A string of the value or the Value

handle_t vot_getVALUES ( handle_t  handle  ) 

Gets the VALUES node from the parent handle.

vot_getVALUES -- Gets the VALUES node from the parent handle

Parameters:
handle Parent handle containing a VALUES
Returns:
A handle to the first VALUES node, or zero

handle_t vot_newBINARY ( handle_t  parent_h  ) 

Create new BINARY node under the parent handle.

vot_newBINARY -- Create new BINARY node under the parent handle

Parameters:
parent_h Parent handle of a BINARY
Returns:
A handle to the first BINARY node, or zero

handle_t vot_newBINARY2 ( handle_t  parent_h  ) 

Create new BINARY2 node under the parent handle.

vot_newBINARY2 -- Create new BINARY2 node under the parent handle

Parameters:
parent_h Parent handle of a BINARY2
Returns:
A handle to the first BINARY2 node, or zero

handle_t vot_newCOOSYS ( handle_t  parent_h  ) 

Create new COOSYS node under the parent handle.

vot_newCOOSYS -- Create new COOSYS node under the parent handle

Parameters:
parent_h Parent handle of a COOSYS
Returns:
A handle to the first COOSYS node, or zero

handle_t vot_newDATA ( handle_t  parent_h  ) 

Create new DATA node under the parent handle.

vot_newDATA -- Create new DATA node under the parent handle

Parameters:
parent_h Parent handle of a DATA
Returns:
A handle to the first DATA node, or zero

handle_t vot_newDESCRIPTION ( handle_t  parent_h  ) 

Create new DESCRIPTION node under the parent handle.

vot_newDESCRIPTION -- Create new DESCRIPTION node under the parent handle

Parameters:
parent_h Parent handle of a DESCRIPTION
Returns:
A handle to the first DESCRIPTION node, or zero

handle_t vot_newFIELD ( handle_t  parent_h  ) 

Create new FIELD node under the parent handle.

vot_newFIELD -- Create new FIELD node under the parent handle

Parameters:
parent_h Parent handle of a FIELD
Returns:
A handle to the first FIELD node, or zero

handle_t vot_newFIELDRef ( handle_t  parent_h  ) 

Create new FIELDref node under the parent handle.

vot_newFIELDref -- Create new FIELDref node under the parent handle

Parameters:
parent_h Parent handle of a FIELDref
Returns:
A handle to the first FIELDref node, or zero

handle_t vot_newFITS ( handle_t  parent_h  ) 

Create new FITS node under the parent handle.

vot_newFITS -- Create new FITS node under the parent handle

Parameters:
parent_h Parent handle of a FITS
Returns:
A handle to the first FITS node, or zero

handle_t vot_newGROUP ( handle_t  parent_h  ) 

Create new GROUP node under the parent handle.

vot_newGROUP -- Create new GROUP node under the parent handle

Parameters:
parent_h Parent handle of a GROUP
Returns:
A handle to the first GROUP node, or zero

handle_t vot_newINFO ( handle_t  parent_h  ) 

Create new INFO node under the parent handle.

vot_newINFO -- Create new INFO node under the parent handle

Parameters:
parent_h Parent handle of a INFO
Returns:
A handle to the first INFO node, or zero

handle_t vot_newLINK ( handle_t  parent_h  ) 

Create new LINK node under the parent handle.

vot_newLINK -- Create new LINK node under the parent handle

Parameters:
parent_h Parent handle of a LINK
Returns:
A handle to the first LINK node, or zero

handle_t vot_newMAX ( handle_t  parent_h  ) 

Create new MAX node under the parent handle.

vot_newMAX -- Create new MAX node under the parent handle

Parameters:
parent_h Parent handle of a MAX
Returns:
A handle to the first MAX node, or zero

handle_t vot_newMIN ( handle_t  parent_h  ) 

Create new MIN node under the parent handle.

vot_newMIN -- Create new MIN node under the parent handle

Parameters:
parent_h Parent handle of a MIN
Returns:
A handle to the first MIN node, or zero

handle_t vot_newNode ( handle_t  parent,
int  type 
)

Creates a new blank unlinked node.

vot_newNode -- Creates a new blank unlinked node.

Parameters:
parent A handle to the Element that you want to add a node to
type The type of node you wish to create
Returns:
A handle to the created node

handle_t vot_newOPTION ( handle_t  parent_h  ) 

Create new OPTION node under the parent handle.

vot_newOPTION -- Create new OPTION node under the parent handle

Parameters:
parent_h Parent handle of a OPTION
Returns:
A handle to the first OPTION node, or zero

handle_t vot_newPARAM ( handle_t  parent_h  ) 

Create new PARAM node under the parent handle.

vot_newPARAM -- Create new PARAM node under the parent handle

Parameters:
parent_h Parent handle of a PARAM
Returns:
A handle to the first PARAM node, or zero

handle_t vot_newPARAMRef ( handle_t  parent_h  ) 

Create new PARAMRef node under the parent handle.

vot_newPARAMRef -- Create new PARAMref node under the parent handle

Parameters:
parent_h Parent handle of a PARAMRef
Returns:
A handle to the first PARAMRef node, or zero

handle_t vot_newRESOURCE ( handle_t  parent_h  ) 

Create new RESOURCE node under the parent handle.

vot_newRESOURCE -- Create new RESOURCE node under the parent handle

Parameters:
parent_h Parent handle of a RESOURCE
Returns:
A handle to the first RESOURCE node, or zero

handle_t vot_newSTREAM ( handle_t  parent_h  ) 

Create new STREAM node under the parent handle.

vot_newSTREAM -- Create new STREAM node under the parent handle

Parameters:
parent_h Parent handle of a STREAM
Returns:
A handle to the first STREAM node, or zero

handle_t vot_newTABLE ( handle_t  parent_h  ) 

Create new TABLE node under the parent handle.

vot_newTABLE -- Create new TABLE node under the parent handle

Parameters:
parent_h Parent handle of a TABLE
Returns:
A handle to the first TABLE node, or zero

handle_t vot_newTABLEDATA ( handle_t  parent_h  ) 

Create new TABLEDATA node under the parent handle.

vot_newTABLEDATA -- Create new TABLEDATA node under the parent handle

Parameters:
parent_h Parent handle of a TABLEDATA
Returns:
A handle to the first TABLEDATA node, or zero

handle_t vot_newTD ( handle_t  parent_h  ) 

Create new TD node under the parent handle.

vot_newTD -- Create new TD node under the parent handle

Parameters:
parent_h Parent handle of a TD
Returns:
A handle to the first TD node, or zero

handle_t vot_newTR ( handle_t  parent_h  ) 

Create new TR node under the parent handle.

vot_newTR -- Create new TR node under the parent handle

Parameters:
parent_h Parent handle of a TR
Returns:
A handle to the first TR node, or zero

handle_t vot_newVALUES ( handle_t  parent_h  ) 

Create new VALUES node under the parent handle.

vot_newVALUES -- Create new VALUES node under the parent handle

Parameters:
parent_h Parent handle of a VALUES
Returns:
A handle to the first VALUES node, or zero

handle_t vot_openVOTABLE ( char *  arg  ) 

Parse a VOTable and return a handle to it.

vot_openVOTABLE -- Parse a VOTable and return a handle to it

Parameters:
arg The source of the table
Returns:
The root node handle of the VOTable

int vot_setAttr ( handle_t  elem_h,
char *  attr,
char *  value 
)

Set the attribute for the Element.

vot_setAttr -- Set the attribute for the Element.

Parameters:
elem_h A handle_t the Element
attr A string holding the attribute name
value A string holding the attribute value
Returns:
The status of the set

int vot_setValue ( handle_t  elem_h,
char *  value 
)

Set the Value for the ELEMENT.

vot_setValue -- Set the Value for the ELEMENT.

Parameters:
elem_h A handle_t the ELEMENT
value A string holding the value
Returns:
The status of the set

vot_setWarnings ( int  value  ) 

Set the warning level.

vot_setWarnings -- Set the warning level.

Parameters:
value Warning level
Returns:
nothing

int vot_typeOf ( handle_t  elem_h  ) 

Return type of the Element.

vot_typeOf -- Return type of the Element.

Parameters:
elem_h A handle_t the Element
Returns:
An integer of the type

int vot_valueOf ( handle_t  elem_h  ) 

Return type of the Element.

vot_valueOf -- Return type of the Element.

Parameters:
elem_h A handle_t the Element
Returns:
An integer of the type

vot_writeASV ( handle_t  node,
char *  fname,
int  header 
)

Write the VOTable to the file descriptor as a ASV file.

vot_writeASV -- Write the VOTable to the file descriptor as a ASV file

Parameters:
node A handle to an Element that you to print
fname Output filename (or "stdout" or "-" for STDOUT)
header Write output header?
Returns:
nothing

vot_writeBSV ( handle_t  node,
char *  fname,
int  header 
)

Write the VOTable to the file descriptor as a BSV file.

vot_writeBSV -- Write the VOTable to the file descriptor as a BSV file

Parameters:
node A handle to an Element that you to print
fname Output filename (or "stdout" or "-" for STDOUT)
header Write output header?
Returns:
nothing

vot_writeCSV ( handle_t  node,
char *  fname,
int  header 
)

Write the VOTable to the file descriptor as a CSV file.

vot_writeCSV -- Write the VOTable to the file descriptor as a CSV file

Parameters:
node A handle to an Element that you to print
fname Output filename (or "stdout" or "-" for STDOUT)
header Write output header?
Returns:
nothing

vot_writeFITS ( handle_t  node,
char *  fname 
)

Write the VOTable to the file descriptor as an FITS table.

vot_writeFITS -- Write the VOTable to the file descriptor as a FITS table.

Parameters:
node A handle to an Element that you to print
fname Output filename (or "stdout" or "-" for STDOUT)
Returns:
nothing

vot_writeHTML ( handle_t  node,
char *  ifname,
char *  ofname 
)

Write the VOTable to the file descriptor as HTML.

vot_writeHTML -- Write the VOTable to the file descriptor as HTML.

Parameters:
node A handle to an Element that you to print
ifname Input filename
ofname Output filename (or "stdout" or "-" for STDOUT)
Returns:
nothing

vot_writeSHTML ( handle_t  node,
char *  ifname,
char *  ofname 
)

Write the VOTable to the file descriptor as an HTML table.

vot_writeSHTML -- Write the VOTable to the file descriptor as an HTML table.

Parameters:
node A handle to an Element that you to print
ifname Input filename
ofname Output filename (or "stdout" or "-" for STDOUT)
Returns:
nothing

vot_writeTSV ( handle_t  node,
char *  fname,
int  header 
)

Write the VOTable to the file descriptor as a TSV file.

vot_writeTSV -- Write the VOTable to the file descriptor as a TSV file

Parameters:
node A handle to an Element that you to print
fname Output filename (or "stdout" or "-" for STDOUT)
header Write output header?
Returns:
nothing

vot_writeVOTable ( handle_t  node,
char *  fname,
int  indent 
)

Write the VOTable to the file descriptor.

vot_writeVOTable -- Write the VOTable to the file descriptor.

Parameters:
node A handle to an Element that you to print
fname Output filename (or "stdout" or "-" for STDOUT)
indent Number of spaces to indent at each level
Returns:
nothing

void votEmsg ( char *  msg  ) 

votEmsg -- Error message print utility.

Variable Documentation

int children

allowed parent types

Stack* element_stack = NULL

************************************************************************* Public Interface

vot = vot_openVOTABLE (filename|str|NULL) vot_closeVOTABLE (vot)

res = vot_getRESOURCE (vot|res) tab = vot_getTABLE (res) field = vot_getFIELD (tab)

data = vot_getDATA (tab)

tdata = vot_getTABLEDATA (data) // data elements tr = vot_getTR (tdata) td = vot_getTD (tr) bin = vot_getBINARY (data) bin = vot_getBINARY2 (data) fits = vot_getFITS (data)

group = vot_getGROUP (vot|res|tab|group) fldref = vot_getFIELDRef (group) parref = vot_getPARAMRef (group)

desc = vot_getDESCRIPTION (handle) param = vot_getPARAM (handle) info = vot_getINFO (handle) stream = vot_getSTREAM (bin|fits)

val = vot_getVALUES (field|param|info) min = vot_getMIN (val) max = vot_getMAX (val) opt = vot_getOPTION (val)

link = vot_getLINK (res|info|param|field|table)

sys = vot_getCOOSYS (vot) // Compatability

h = vot_newRESOURCE (handle_t parent_h) h = vot_newTABLE (handle_t parent_h) h = vot_newFIELD (handle_t parent_h) h = vot_newDATA (handle_t parent_h) h = vot_newTABLEDATA (handle_t parent_h) h = vot_newTR (handle_t parent_h) h = vot_newTD (handle_t parent_h) h = vot_newBINARY (handle_t parent_h) h = vot_newBINARY2 (handle_t parent_h) h = vot_newFITS (handle_t parent_h) h = vot_newGROUP (handle_t parent_h) h = vot_newFIELDRef (handle_t parent_h) h = vot_newPARAMRef (handle_t parent_h) h = vot_newDESCRIPTION (handle_t parent_h) h = vot_newPARAM (handle_t parent_h) h = vot_newINFO (handle_t parent_h) h = vot_newSTREAM (handle_t parent_h) h = vot_newVALUES (handle_t parent_h) h = vot_newMIN (handle_t parent_h) h = vot_newMAX (handle_t parent_h) h = vot_newOPTION (handle_t parent_h) h = vot_newLINK (handle_t parent_h) h = vot_newCOOSYS (handle_t parent_h)

handle = vot_newNode (parent, type) vot_freeNode (node) vot_deleteNode (node) vot_attachNode (parent, new) handle = vot_copyElement (handle_t source_h, handle_t parent_h)

val = vot_getValue (handle) stat = vot_setValue (handle, value)

attr = vot_getAttr (handle, attr) stat = vot_setAttr (handle, attr, value)

type = vot_getDATAType (data) // Utilities typeStr = vot_getDATATypeString (data)

nc = vot_getNCols (tdata_h) nr = vot_getNRows (tdata_h) val = vot_getTableCell (tdata_h, row, col) stat = vot_sortTable (tdata_h, col, string_sort, sort_order)

len = vot_getLength (elem_h) N = vot_getNumberOf (elem_h, type)

col = vot_colByName (tab_h, name, alt) col = vot_colByUCD (tab_h, name, alt) col = vot_colByID (tab_h, name, alt)

handle = vot_findByAttr (parent, name, value) handle *vot_findInGroup (group, type) handle = vot_getNext (handle) handle = vot_getSibling (handle) handle = vot_getChild (handle) handle = vot_getParent (handle) handle = vot_getChildOfType (handle, int type)

int = vot_valueOf (handle) type = vot_typeOf (handle) vot_setWarnings (value)

vot_writeVOTable (handle, char *fname, int indent) vot_writeHTML (handle, char *fname) vot_writeSHTML (handle, char *fname) vot_writeFITS (handle, char *fname) vot_writeASV (handle, char *fname, int hdr) vot_writeBSV (handle, char *fname, int hdr) vot_writeCSV (handle, char *fname, int hdr) vot_writeTSV (handle, char *fname, int hdr) vot_writeDelimited (handle, char *fname, char delim, int hdr)

int parents

element type

Generated on Wed Feb 27 21:10:08 2013 for libVOTable by  doxygen 1.5.9