Loading [MathJax]/extensions/TeX/AMSsymbols.js
LALMetaIO 4.0.6.1-6c6b863
All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
LIGOLwXML.c File Reference

Routines to write LIGO metadata database structures to LIGO lightweight XML files. More...

Prototypes

LIGOLwXMLStreamXLALOpenLIGOLwXMLFile (const char *path)
 Open an XML file for writing. More...
 
int XLALCloseLIGOLwXMLFile (LIGOLwXMLStream *xml)
 Close an XML stream. More...
 
int XLALCreateLIGODataFileName (char *filename, size_t size, const char *dataSource, const char *dataDescription, const LIGOTimeGPS *gpsStartTime, const LIGOTimeGPS *gpsEndTime, const char *extension)
 Creates a XML filename accordingly to document T050017. More...
 

Detailed Description

Routines to write LIGO metadata database structures to LIGO lightweight XML files.

Author
Brown, D. A.

Description

The routine XLALCreateLIGOLwXMLFileName creates a name for a LIGO lightweight XML file that is in accordance with the specifications of document T050017.

Algorithm

None.

Uses

fopen() XLALFilePrintf() fclose()

Notes

Definition in file LIGOLwXML.c.

Go to the source code of this file.

Function Documentation

◆ XLALOpenLIGOLwXMLFile()

LIGOLwXMLStream * XLALOpenLIGOLwXMLFile ( const char *  path)

Open an XML file for writing.

The return value is a pointer to a new LIGOLwXMLStream file handle or NULL on failure.

Definition at line 67 of file LIGOLwXML.c.

◆ XLALCloseLIGOLwXMLFile()

int XLALCloseLIGOLwXMLFile ( LIGOLwXMLStream xml)

Close an XML stream.

On failure the stream is left in an undefined state, and has not been free()'ed. Sorry.

Definition at line 109 of file LIGOLwXML.c.

◆ XLALCreateLIGODataFileName()

int XLALCreateLIGODataFileName ( char *  filename,
size_t  size,
const char *  dataSource,
const char *  dataDescription,
const LIGOTimeGPS gpsStartTime,
const LIGOTimeGPS gpsEndTime,
const char *  extension 
)

Creates a XML filename accordingly to document T050017.

Definition at line 132 of file LIGOLwXML.c.