Detailed Description

Sub-module for general printing of various input 'types' (as defined in Header UserInput.h) as 'string values', These can be thought of as the 'inverse functions' to Header UserInputParse.h.

Author: Reinhard Prix

Prototypes
char *	XLALPrintStringValueOfBOOLEAN (const BOOLEAN *valBOOLEAN)
	Return 'string value' (allocated here) of a BOOLEAN. More...

char *	XLALPrintStringValueOfINT4 (const INT4 *valINT4)
	Return 'string value' (allocated here) of an INT4. More...

char *	XLALPrintStringValueOfINT8 (const INT8 *valINT8)
	Return 'string value' (allocated here) of an INT8. More...

char *	XLALPrintStringValueOfUINT4 (const UINT4 *valUINT4)
	Return 'string value' (allocated here) of an UINT4. More...

char *	XLALPrintStringValueOfUINT8 (const UINT8 *valUINT8)
	Return 'string value' (allocated here) of an UINT8. More...

char *	XLALPrintStringValueOfREAL4 (const REAL4 *valREAL4)
	Return 'string value' (allocated here) of a REAL4 (printed at full precision) More...

char *	XLALPrintStringValueOfREAL8 (const REAL8 *valREAL8)
	Return 'string value' (allocated here) of a REAL8 (printed at full precision) More...

char *	XLALPrintStringValueOfEPOCH (const LIGOTimeGPS *valGPS)
	Return 'string value' (allocated here) of a GPS epoch, as parseable by XLALParseStringValueAs[GPS\|EPOCH]() More...

char *	XLALPrintStringValueOfINT4Range (const INT4Range *int4Range)
	Return 'string value' (allocated here) of a INT4Range, as parseable by XLALParseStringValueAsINT4Range() More...

char *	XLALPrintStringValueOfREAL8Range (const REAL8Range *real8Range)
	Return 'string value' (allocated here) of a REAL8Range, as parseable by XLALParseStringValueAsREAL8Range() More...

char *	XLALPrintStringValueOfEPOCHRange (const LIGOTimeGPSRange *gpsRange)
	Return 'string value' (allocated here) of a EPOCHRange, as parseable by XLALParseStringValueAsEPOCHRange() More...

char *	XLALPrintStringValueOfUserEnum (const int valEnum, const UserChoices enumData)
	Return 'string value' (allocated here) of a user selection of an enumeration value. More...

char *	XLALFormatHelpStringOfUserEnum (const UserChoices *enumData)
	Return format help string (allocated here) for a user selection of an enumeration value. More...

char *	XLALPrintStringValueOfUserFlag (const int valFlag, const UserChoices flagData)
	Return 'string value' (allocated here) of a user selection of an bitflag value. More...

char *	XLALFormatHelpStringOfUserFlag (const UserChoices *flagData)
	Return format help string (allocated here) for a user selection of an bitflag value. More...

char *	XLALPrintStringValueOfSTRING (char **valSTRING)
	Return 'string value' (allocated here) of a STRING, surrounded by double quotes. More...

char *	XLALPrintStringValueOfSTRINGVector (LALStringVector **valSTRINGVector)
	Return 'string value' (allocated here) of a STRINGVector, by turning into comma-separated list of strings, each surrounded by single quotes. More...

	DECL_XLALPrintStringValueOfVector (INT4)

	DECL_XLALPrintStringValueOfVector (UINT4)

	DECL_XLALPrintStringValueOfVector (REAL8)

Macros
#define	XLALPrintStringValueOfRAJ XLALPrintStringValueOfREAL8

#define	XLALPrintStringValueOfDECJ XLALPrintStringValueOfREAL8

#define	XLALPrintStringValueOfRAJRange XLALPrintStringValueOfREAL8Range

#define	XLALPrintStringValueOfDECJRange XLALPrintStringValueOfREAL8Range

#define	DECL_XLALPrintStringValueOfVector(CTYPE) char XLALPrintStringValueOf##CTYPE##Vector ( CTYPE##Vector *valVector )

Function Documentation

◆ XLALPrintStringValueOfBOOLEAN()

char* XLALPrintStringValueOfBOOLEAN ( const BOOLEAN * valBOOLEAN )

Return 'string value' (allocated here) of a BOOLEAN.

Definition at line 97 of file UserInputPrint.c.

◆ XLALPrintStringValueOfINT4()

char* XLALPrintStringValueOfINT4 ( const INT4 * valINT4 )

Return 'string value' (allocated here) of an INT4.

Definition at line 47 of file UserInputPrint.c.

◆ XLALPrintStringValueOfINT8()

char* XLALPrintStringValueOfINT8 ( const INT8 * valINT8 )

Return 'string value' (allocated here) of an INT8.

Definition at line 37 of file UserInputPrint.c.

◆ XLALPrintStringValueOfUINT4()

char* XLALPrintStringValueOfUINT4 ( const UINT4 * valUINT4 )

Return 'string value' (allocated here) of an UINT4.

Definition at line 67 of file UserInputPrint.c.

◆ XLALPrintStringValueOfUINT8()

char* XLALPrintStringValueOfUINT8 ( const UINT8 * valUINT8 )

Return 'string value' (allocated here) of an UINT8.

Definition at line 57 of file UserInputPrint.c.

◆ XLALPrintStringValueOfREAL4()

char* XLALPrintStringValueOfREAL4 ( const REAL4 * valREAL4 )

Return 'string value' (allocated here) of a REAL4 (printed at full precision)

Definition at line 87 of file UserInputPrint.c.

◆ XLALPrintStringValueOfREAL8()

char* XLALPrintStringValueOfREAL8 ( const REAL8 * valREAL8 )

Return 'string value' (allocated here) of a REAL8 (printed at full precision)

Definition at line 77 of file UserInputPrint.c.

◆ XLALPrintStringValueOfEPOCH()

char* XLALPrintStringValueOfEPOCH ( const LIGOTimeGPS * valGPS )

Return 'string value' (allocated here) of a GPS epoch, as parseable by XLALParseStringValueAs[GPS|EPOCH]()

Definition at line 108 of file UserInputPrint.c.

◆ XLALPrintStringValueOfINT4Range()

char* XLALPrintStringValueOfINT4Range ( const INT4Range * int4Range )

Return 'string value' (allocated here) of a INT4Range, as parseable by XLALParseStringValueAsINT4Range()

Definition at line 141 of file UserInputPrint.c.

◆ XLALPrintStringValueOfREAL8Range()

char* XLALPrintStringValueOfREAL8Range ( const REAL8Range * real8Range )

Return 'string value' (allocated here) of a REAL8Range, as parseable by XLALParseStringValueAsREAL8Range()

Definition at line 160 of file UserInputPrint.c.

◆ XLALPrintStringValueOfEPOCHRange()

char* XLALPrintStringValueOfEPOCHRange ( const LIGOTimeGPSRange * gpsRange )

Return 'string value' (allocated here) of a EPOCHRange, as parseable by XLALParseStringValueAsEPOCHRange()

Definition at line 179 of file UserInputPrint.c.

◆ XLALPrintStringValueOfUserEnum()

char* XLALPrintStringValueOfUserEnum	(	const int *	valEnum,
		const UserChoices *	enumData
	)

Return 'string value' (allocated here) of a user selection of an enumeration value.

The output is parseable by XLALParseStringValueOfUserEnum().

Definition at line 199 of file UserInputPrint.c.

◆ XLALFormatHelpStringOfUserEnum()

char* XLALFormatHelpStringOfUserEnum ( const UserChoices * enumData )

Return format help string (allocated here) for a user selection of an enumeration value.

Definition at line 223 of file UserInputPrint.c.

◆ XLALPrintStringValueOfUserFlag()

char* XLALPrintStringValueOfUserFlag	(	const int *	valFlag,
		const UserChoices *	flagData
	)

Return 'string value' (allocated here) of a user selection of an bitflag value.

The output is parseable by XLALParseStringValueOfUserFlag().

Definition at line 261 of file UserInputPrint.c.

◆ XLALFormatHelpStringOfUserFlag()

char* XLALFormatHelpStringOfUserFlag ( const UserChoices * flagData )

Return format help string (allocated here) for a user selection of an bitflag value.

Definition at line 295 of file UserInputPrint.c.

◆ XLALPrintStringValueOfSTRING()

char* XLALPrintStringValueOfSTRING ( CHAR ** valSTRING )

Return 'string value' (allocated here) of a STRING, surrounded by double quotes.

The output is parseable by XLALParseStringValueAsSTRING(). In case of NULL input, returns the string 'NULL'.

Definition at line 120 of file UserInputPrint.c.

◆ XLALPrintStringValueOfSTRINGVector()

char* XLALPrintStringValueOfSTRINGVector ( LALStringVector ** valSTRINGVector )

Return 'string value' (allocated here) of a STRINGVector, by turning into comma-separated list of strings, each surrounded by single quotes.

The output is parseable by XLALParseStringValueAsSTRINGVector(). In case of a NULL or empty vector (data==NULL|length==0), generate the string 'NULL'.

Definition at line 340 of file UserInputPrint.c.

◆ DECL_XLALPrintStringValueOfVector() [1/3]

DECL_XLALPrintStringValueOfVector ( INT4 )

◆ DECL_XLALPrintStringValueOfVector() [2/3]

DECL_XLALPrintStringValueOfVector ( UINT4 )

◆ DECL_XLALPrintStringValueOfVector() [3/3]

DECL_XLALPrintStringValueOfVector ( REAL8 )

Macro Definition Documentation

◆ XLALPrintStringValueOfRAJ

#define XLALPrintStringValueOfRAJ XLALPrintStringValueOfREAL8

Definition at line 46 of file UserInputPrint.h.

◆ XLALPrintStringValueOfDECJ

#define XLALPrintStringValueOfDECJ XLALPrintStringValueOfREAL8

Definition at line 47 of file UserInputPrint.h.

◆ XLALPrintStringValueOfRAJRange

#define XLALPrintStringValueOfRAJRange XLALPrintStringValueOfREAL8Range

Definition at line 48 of file UserInputPrint.h.

◆ XLALPrintStringValueOfDECJRange

#define XLALPrintStringValueOfDECJRange XLALPrintStringValueOfREAL8Range

Definition at line 49 of file UserInputPrint.h.

◆ DECL_XLALPrintStringValueOfVector

#define DECL_XLALPrintStringValueOfVector ( CTYPE ) char *XLALPrintStringValueOf##CTYPE##Vector ( CTYPE##Vector **valVector )

Definition at line 77 of file UserInputPrint.h.