LALMetaIO 4.0.6.1-eeff03c
sim_burst.c File Reference

Prototypes

SimBurstXLALCreateSimBurst (void)
 Create a SimBurst structure. More...
 
SimBurstXLALDestroySimBurst (SimBurst *row)
 Destroy a SimBurst structure. More...
 
void XLALDestroySimBurstTable (SimBurst *head)
 Destroy a SimBurst linked list. More...
 
SimBurstXLALSimBurstTableFromLIGOLw (const char *filename)
 Read the sim_burst table from a LIGO Light Weight XML file into a linked list of SimBurst structures. More...
 
int XLALWriteLIGOLwXMLSimBurstTable (LIGOLwXMLStream *xml, const SimBurst *sim_burst)
 Write a sim_burst table to an XML file. More...
 
long XLALSimBurstAssignIDs (SimBurst *sim_burst, long process_id, long time_slide_id, long simulation_id)
 Assign simulation_id values to the entries in a sim_burst linked list. More...
 

Go to the source code of this file.

Function Documentation

◆ XLALCreateSimBurst()

SimBurst * XLALCreateSimBurst ( void  )

Create a SimBurst structure.

Definition at line 40 of file sim_burst.c.

◆ XLALDestroySimBurst()

SimBurst * XLALDestroySimBurst ( SimBurst row)

Destroy a SimBurst structure.

Definition at line 73 of file sim_burst.c.

◆ XLALDestroySimBurstTable()

void XLALDestroySimBurstTable ( SimBurst head)

Destroy a SimBurst linked list.

Definition at line 84 of file sim_burst.c.

◆ XLALSimBurstTableFromLIGOLw()

SimBurst * XLALSimBurstTableFromLIGOLw ( const char *  filename)

Read the sim_burst table from a LIGO Light Weight XML file into a linked list of SimBurst structures.

Definition at line 95 of file sim_burst.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.

◆ XLALSimBurstAssignIDs()

long XLALSimBurstAssignIDs ( SimBurst sim_burst,
long  process_id,
long  time_slide_id,
long  simulation_id 
)

Assign simulation_id values to the entries in a sim_burst linked list.

All sim_burst rows in the list will be blamed on the given process_id, and assigned simulation_ids in order starting with the given simulation_id. The return value is the next simulation_id after the last one assigned to a row in the list.

Definition at line 388 of file sim_burst.c.