Provides functions for writing the LIGO metdata database table structres to LIGO light weight XML files. More...

Prototypes
LIGOLwXMLStream *	XLALOpenLIGOLwXMLFile (const char *path)
	Open an XML file for writing. More...

int	XLALCloseLIGOLwXMLFile (LIGOLwXMLStream *xml)
	Close an XML stream. More...

int	XLALWriteLIGOLwXMLProcessTable (LIGOLwXMLStream , const ProcessTable )
	Write a process table to an XML file. More...

int	XLALWriteLIGOLwXMLProcessParamsTable (LIGOLwXMLStream , const ProcessParamsTable )
	Write a process_params table to an XML file. More...

int	XLALWriteLIGOLwXMLSearchSummaryTable (LIGOLwXMLStream , const SearchSummaryTable )
	Write a search_summary table to an XML file. More...

int	XLALWriteLIGOLwXMLSnglBurstTable (LIGOLwXMLStream , const SnglBurst )
	Write a sngl_burst table to an XML file. More...

int	XLALWriteLIGOLwXMLSnglInspiralTable (LIGOLwXMLStream xml, const SnglInspiralTable sngl_inspiral)
	Write a linked list of SnglInspiralTable structures to a the sngl_inspiral table in a LIGO Light Weight XML file. More...

int	XLALWriteLIGOLwXMLSimBurstTable (LIGOLwXMLStream , const SimBurst )
	Write a sim_burst table to an XML file. More...

int	XLALWriteLIGOLwXMLSimInspiralTable (LIGOLwXMLStream , const SimInspiralTable )
	Write a sim_inspiral table to an XML file. More...

int	XLALWriteLIGOLwXMLSimRingdownTable (LIGOLwXMLStream xml, const SimRingdownTable sim_ringdown)
	Write a sim_ringdown table to an XML file. More...

int	XLALWriteLIGOLwXMLTimeSlideTable (LIGOLwXMLStream , const TimeSlide )
	Write a time_slide table to an XML file. More...

int	XLALWriteLIGOLwXMLSegmentTable (LIGOLwXMLStream xml, const SegmentTable segment_table)
	Write a segment table to an XML file. More...

int	XLALCreateLIGODataFileName (char filename, size_t size, const char dataSource, const char dataDescription, const LIGOTimeGPS startTime, const LIGOTimeGPS endTime, const char extension)
	Creates a XML filename accordingly to document T050017. More...

Detailed Description

Provides functions for writing the LIGO metdata database table structres to LIGO light weight XML files.

Author: Brown, D. A.

Synopsis

#include <lal/LIGOLwXML.h>

Definition in file LIGOLwXML.h.

Go to the source code of this file.

Data Structures
struct	LIGOLwXMLStream
	This structure contains the file stream and current table type for writing to LIGO lightweight XML files. More...

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.

◆ XLALWriteLIGOLwXMLProcessTable()

int XLALWriteLIGOLwXMLProcessTable	(	LIGOLwXMLStream *	xml,
		const ProcessTable *	process
	)

Write a process table to an XML file.

Definition at line 471 of file processtable.c.

◆ XLALWriteLIGOLwXMLProcessParamsTable()

int XLALWriteLIGOLwXMLProcessParamsTable	(	LIGOLwXMLStream *	xml,
		const ProcessParamsTable *	process_params
	)

Write a process_params table to an XML file.

Definition at line 204 of file process_params.c.

◆ XLALWriteLIGOLwXMLSearchSummaryTable()

int XLALWriteLIGOLwXMLSearchSummaryTable	(	LIGOLwXMLStream *	xml,
		const SearchSummaryTable *	search_summary
	)

Write a search_summary table to an XML file.

Definition at line 340 of file search_summary.c.

◆ XLALWriteLIGOLwXMLSnglBurstTable()

int XLALWriteLIGOLwXMLSnglBurstTable	(	LIGOLwXMLStream *	xml,
		const SnglBurst *	sngl_burst
	)

Write a sngl_burst table to an XML file.

Definition at line 230 of file sngl_burst.c.

◆ XLALWriteLIGOLwXMLSnglInspiralTable()

int XLALWriteLIGOLwXMLSnglInspiralTable	(	LIGOLwXMLStream *	xml,
		const SnglInspiralTable *	sngl_inspiral
	)

Write a linked list of SnglInspiralTable structures to a the sngl_inspiral table in a LIGO Light Weight XML file.

Definition at line 358 of file sngl_inspiral.c.

◆ XLALWriteLIGOLwXMLSimBurstTable()

int XLALWriteLIGOLwXMLSimBurstTable	(	LIGOLwXMLStream *	xml,
		const SimBurst *	sim_burst
	)

Write a sim_burst table to an XML file.

Definition at line 305 of file sim_burst.c.

◆ XLALWriteLIGOLwXMLSimInspiralTable()

int XLALWriteLIGOLwXMLSimInspiralTable	(	LIGOLwXMLStream *	xml,
		const SimInspiralTable *	sim_inspiral
	)

Write a sim_inspiral table to an XML file.

Definition at line 365 of file sim_inspiral.c.

◆ XLALWriteLIGOLwXMLSimRingdownTable()

int XLALWriteLIGOLwXMLSimRingdownTable	(	LIGOLwXMLStream *	xml,
		const SimRingdownTable *	sim_ringdown
	)

Write a sim_ringdown table to an XML file.

Definition at line 262 of file sim_ringdown.c.

◆ XLALWriteLIGOLwXMLTimeSlideTable()

int XLALWriteLIGOLwXMLTimeSlideTable	(	LIGOLwXMLStream *	xml,
		const TimeSlide *	time_slide
	)

Write a time_slide table to an XML file.

Definition at line 222 of file time_slide.c.

◆ XLALWriteLIGOLwXMLSegmentTable()

int XLALWriteLIGOLwXMLSegmentTable	(	LIGOLwXMLStream *	xml,
		const SegmentTable *	segment_table
	)

Write a segment table to an XML file.

Definition at line 93 of file segment.c.

◆ XLALCreateLIGODataFileName()

int XLALCreateLIGODataFileName	(	char *	filename,
		size_t	size,
		const char *	dataSource,
		const char *	dataDescription,
		const LIGOTimeGPS *	startTime,
		const LIGOTimeGPS *	endTime,
		const char *	extension
	)

Creates a XML filename accordingly to document T050017.

Definition at line 132 of file LIGOLwXML.c.

Prototypes