StringVector.h File Reference

Author:
Reinhard Prix Creation/destruction/manipulation API for 'StringVector' type objects, which are just LAL 'vectors' of CHAR * pointers.
More...

#include <stdarg.h>
#include <lal/LALDatatypes.h>
#include <lal/LALRCSID.h>

Include dependency graph for StringVector.h:

Go to the source code of this file.

Functions

 NRCSID (STRINGVECTORH,"$Id: StringVector.h,v 1.1 2008/02/22 16:11:07 reinhard Exp $")
LALStringVectorXLALCreateStringVector (const CHAR *str1,...)
 Create a StringVector from the list of strings passed as arguments.
LALStringVectorXLALAppendString2Vector (LALStringVector *vect, const CHAR *string)
 Append the given string to the string-vector (XLAL interface), return pointer to the resulting string-vector, or NULL on error.
void XLALDestroyStringVector (LALStringVector *vect)
 XLAL-interface: Free a string-vector ;).
int XLALSortStringVector (LALStringVector *strings)
 Sort string-vector alphabetically.
LALStringVectorXLALParseCSV2StringVector (const CHAR *CSVlist)
 Parse a list of comma-separated values (CSV) into a StringVector.


Detailed Description

Author:
Reinhard Prix Creation/destruction/manipulation API for 'StringVector' type objects, which are just LAL 'vectors' of CHAR * pointers.

Date:
2008
Id
StringVector.h,v 1.1 2008/02/22 16:11:07 reinhard Exp

Definition in file StringVector.h.


Function Documentation

NRCSID ( STRINGVECTORH  ,
"$Id: StringVector.  h,
v 1.1 2008/02/22 16:11:07 reinhard Exp $"   
)

LALStringVector* XLALCreateStringVector ( const CHAR str1,
  ... 
)

Create a StringVector from the list of strings passed as arguments.

Note:
All arguments MUST be CHAR* strings. The last argument MUST be NULL, as C cannot deduce the number of arguments otherwise.

Definition at line 108 of file StringVector.c.

LALStringVector* XLALAppendString2Vector ( LALStringVector vect,
const CHAR string 
)

Append the given string to the string-vector (XLAL interface), return pointer to the resulting string-vector, or NULL on error.

Note:
It is allowed to pass NULL as the input string-vector 'vect', which corresponds to creating a new string-vector with a single element 'string'
Parameters:
vect  input string-vector to append to
string  string to append

Definition at line 62 of file StringVector.c.

void XLALDestroyStringVector ( LALStringVector vect  ) 

XLAL-interface: Free a string-vector ;).

Definition at line 164 of file StringVector.c.

int XLALSortStringVector ( LALStringVector strings  ) 

Sort string-vector alphabetically.

Definition at line 201 of file StringVector.c.

LALStringVector* XLALParseCSV2StringVector ( const CHAR CSVlist  ) 

Parse a list of comma-separated values (CSV) into a StringVector.

Note:
surrounding whitespace is removed from the 'values'.

Definition at line 220 of file StringVector.c.


Generated on Thu Aug 21 03:14:13 2008 for LAL by  doxygen 1.5.2