votParse.h File Reference

Public procedure declarations for the VOTable interface. More...

Go to the source code of this file.

Defines

#define NUM_ELEMENTS   25
#define TY_ROOT   000000000
#define TY_VOTABLE   000000001
#define TY_RESOURCE   000000002
#define TY_FIELD   000000004
#define TY_PARAM   000000010
#define TY_INFO   000000020
#define TY_TR   000000040
#define TY_TD   000000100
#define TY_TABLE   000000200
#define TY_STREAM   000000400
#define TY_FITS   000001000
#define TY_GROUP   000002000
#define TY_FIELDREF   000004000
#define TY_PARAMREF   000010000
#define TY_MIN   000020000
#define TY_MAX   000040000
#define TY_OPTION   000100000
#define TY_VALUES   000200000
#define TY_LINK   000400000
#define TY_DATA   001000000
#define TY_DESCRIPTION   002000000
#define TY_TABLEDATA   004000000
#define TY_BINARY   010000000
#define TY_BINARY2   020000000
#define TY_COOSYS   100000000
#define TY_DEFINITIONS   200000000
#define OK   0
#define ERR   1
#define TRUE   1
#define FALSE   0
#define handle_t   int

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.
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.
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_newNode (handle_t parent, int type)
 Creates a new blank unlinked node.
void vot_freeNode (handle_t delete_me)
 Destroys the node and all of it's children.
void vot_attachNode (handle_t parent, handle_t new)
 Adds a node as a child of parent.
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_sortTable (handle_t tdata_h, int col, int sort_strings, 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 (handle_t tab, char *attr, char *name, char *alt)
 Get the column number (0-indexed) by named attribute.
int vot_colByName (handle_t tab, char *name, char *alt)
 Get the column number (0-indexed) by 'name' attribute.
int vot_colByUCD (handle_t tab, char *name, char *alt)
 Get the column number (0-indexed) by 'ucd' attribute.
int vot_colByID (handle_t tab, char *name, char *alt)
 Get the column number (0-indexed) by 'id' attribute.
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_handleCount ()
 Get the number of handle_t used (private method).
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_setWarnings (int value)
 Set the warning level.
void votEmsg (char *msg)
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_writeASV (handle_t node, char *fname, int hdr)
 Write the VOTable to the file descriptor as a ASV file.
void vot_writeBSV (handle_t node, char *fname, int hdr)
 Write the VOTable to the file descriptor as a BSV file.
void vot_writeCSV (handle_t node, char *fname, int hdr)
 Write the VOTable to the file descriptor as a CSV file.
void vot_writeTSV (handle_t node, char *fname, int hdr)
 Write the VOTable to the file descriptor as a TSV file.
void vot_writeFITS (handle_t node, char *fname)
 Write the VOTable to the file descriptor as an FITS table.

Detailed Description

Public procedure declarations for the VOTable interface.

VOTPARSE.H -- Public procedure declarations for the VOTable interface.

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

Define Documentation

#define NUM_ELEMENTS   25

VOTable element types

Function Documentation

void 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

void 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.

int vot_colByAttr ( handle_t  tab,
char *  attr,
char *  name,
char *  alt 
)

Get the column number (0-indexed) by named attribute.

vot_colByAttr -- Get the column number (0-indexed) by named attribute.

Parameters:
tab A handle_t the parent
attr A string holding the attribute name
name A string holding the name attribute
value A string holding the alternate name attribute string
Returns:
The matching column number or (-1) if not found

int vot_colByID ( handle_t  tab,
char *  name,
char *  alt 
)

Get the column number (0-indexed) by 'id' attribute.

vot_colByID -- Get the column number (0-indexed) by 'id' attribute.

Parameters:
tab A handle_t the parent
name A string holding the id attribute
value A string holding the alternate id attribute string
Returns:
The matching column number or (-1) if not found

int vot_colByName ( handle_t  tab,
char *  name,
char *  alt 
)

Get the column number (0-indexed) by 'name' attribute.

vot_colByName -- Get the column number (0-indexed) by 'name' attribute.

Parameters:
tab A handle_t the parent
name A string holding the name attribute
value A string holding the alternate name attribute string
Returns:
The matching column number or (-1) if not found

int vot_colByUCD ( handle_t  tab,
char *  name,
char *  alt 
)

Get the column number (0-indexed) by 'ucd' attribute.

vot_colByUCD -- Get the column number (0-indexed) by 'ucd' attribute.

Parameters:
tab A handle_t the parent
name A string holding the ucd attribute
value A string holding the alternate ucd attribute string
Returns:
The matching column number or (-1) if not found

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

void 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

void 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

int 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

int vot_handleCount (  ) 

Get the number of handle_t used (private method).

count of current used handles vot_handleCount -- Get the number of handle_t used (private method)

Returns:
The number of handle_t types currently stored

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.

************************************************************************* Public LIBVOTABLE interface.

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

void 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

void 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

void 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

void 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

void 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

void 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

void 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

void 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

void 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.

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