LALSimulation  5.4.0.1-fe68b98
LALSimInspiralTestGRParams.h
Go to the documentation of this file.
1 /* Copyright (C) 2012 Walter Del pozzo, Evan Ochsner
2  *
3  * This program is free software; you can redistribute it and/or modify
4  * it under the terms of the GNU General Public License as published by
5  * the Free Software Foundation; either version 2 of the License, or
6  * (at your option) any later version.
7  *
8  * This program is distributed in the hope that it will be useful,
9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11  * GNU General Public License for more details.
12  *
13  * You should have received a copy of the GNU General Public License
14  * along with with program; see the file COPYING. If not, write to the
15  * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
16  * MA 02110-1301 USA
17  */
18 
19 #ifndef _LALSIMINSPIRALTESTGRPARAMS_H
20 #define _LALSIMINSPIRALTESTGRPARAMS_H
21 
22 #include <stdio.h>
23 #include <stdbool.h>
24 #include <stdlib.h>
25 #include <string.h>
26 #include <lal/LALMalloc.h>
27 #include <lal/LALError.h>
28 #include <lal/LALSimInspiralWaveformParams.h>
29 
30 #if defined(__cplusplus)
31 extern "C" {
32  #elif 0
33 } /* so that editors will match preceding brace */
34 #endif
35 
36 /**
37  * @addtogroup LALSimInspiral_h
38  * @{
39  */
40 
41 /**
42  * Linked list node for the testing GR parameters
43  */
44 typedef struct tagLALSimInspiralTestGRParamData
45 {
46  char name[32]; /**< Name of the variable */
47  double value; /**< Value of the variable */
49 
50 /**
51  * Linked list of any number of parameters for testing GR
52  */
53 typedef struct tagLALSimInspiralTestGRParam
54 {
55  struct tagLALSimInspiralTestGRParamData *data; /**< Current variable */
56  struct tagLALSimInspiralTestGRParam *next; /**< The next variable in linked list */
58 
59 /** @} */
60 
61 #ifdef SWIG
62 SWIGLAL(INOUT_STRUCTS(LALSimInspiralTestGRParam**, parameter));
63 #endif
64 
66 int XLALSimInspiralAddTestGRParam(LALSimInspiralTestGRParam **parameter, const char *name, const double value);
67 int XLALSimInspiralSetTestGRParam(LALSimInspiralTestGRParam *parameter, const char *name, const double value);
68 double XLALSimInspiralGetTestGRParam(const LALSimInspiralTestGRParam *parameter, const char *name);
69 bool XLALSimInspiralTestGRParamExists(const LALSimInspiralTestGRParam *parameter, const char *name);
73 #if 0
74 { /* so that editors will match succeeding brace */
75 #elif defined(__cplusplus)
76 }
77 #endif
78 
79 #endif /* _LALSIMINSPIRALTESTGRPARAMS_H */
const char * name
int XLALSimInspiralPrintTestGRParam(FILE *fp, LALSimInspiralTestGRParam *parameter)
Function that prints the whole test GR params linked list.
double XLALSimInspiralGetTestGRParam(const LALSimInspiralTestGRParam *parameter, const char *name)
Function that returns the value of the desired parameters in the test GR parameters linked list.
int XLALSimInspiralSetTestGRParam(LALSimInspiralTestGRParam *parameter, const char *name, const double value)
Function that sets the value of the desired parameter in the test GR parameters linked list to 'value...
int XLALSimInspiralAddTestGRParam(LALSimInspiralTestGRParam **parameter, const char *name, const double value)
Function that adds a prameter to the test GR parameters linked list.
int XLALSimInspiralWaveformParamsNonGRAreDefault(LALDict *params)
void XLALSimInspiralDestroyTestGRParam(LALSimInspiralTestGRParam *parameter)
Function that destroys the whole test GR params linked list.
bool XLALSimInspiralTestGRParamExists(const LALSimInspiralTestGRParam *parameter, const char *name)
Function that checks whether the requested parameter exists within the test GR parameters linked list...
LALSimInspiralTestGRParam * XLALSimInspiralCreateTestGRParam(const char *name, double value)
Function that creates the head node of the test GR parameters linked list.
Linked list node for the testing GR parameters.
double value
Value of the variable.
Linked list of any number of parameters for testing GR.
struct tagLALSimInspiralTestGRParamData * data
Current variable.
struct tagLALSimInspiralTestGRParam * next
The next variable in linked list.
Definition: burst.c:245