class gdsParameter : public gdsNamedDatum

Class to store a parameter.

Inheritance:

Public Methods

friend std::istream&	operator >> (std::istream&, gdsParameter&) Input operator.
friend std::ostream&	operator << (std::ostream&, const gdsParameter&) Output operator.
	gdsParameter () Default constructor.
	gdsParameter (const gdsParameter& prm) Copy constructor.
	gdsParameter (const string& Name, gdsDataType DataType, const void* Value, const string& Unit = "", const string& Comment = "") Constructor.
	gdsParameter (const string& Name, gdsDataType DataType, const void* Value, int dim1, const string& Unit = "", const string& Comment = "") Constructor.
	gdsParameter (const string& Name, const gdsDatum& Value, const string& Unit = "", const string& Comment = "") Constructor.
	gdsParameter (const string& Name, char Value, const string& Unit = "", const string& Comment = "") Constructor.
	gdsParameter (const string& Name, short Value, const string& Unit = "", const string& Comment = "") Constructor.
	gdsParameter (const string& Name, int Value, const string& Unit = "", const string& Comment = "") Constructor.
	gdsParameter (const string& Name, long long Value, const string& Unit = "", const string& Comment = "") Constructor.
	gdsParameter (const string& Name, float Value, const string& Unit = "", const string& Comment = "") Constructor.
	gdsParameter (const string& Name, double Value, const string& Unit = "", const string& Comment = "") Constructor.
	gdsParameter (const string& Name, std::complex<float> Value, const string& Unit = "", const string& Comment = "") Constructor.
	gdsParameter (const string& Name, std::complex<double> Value, const string& Unit = "", const string& Comment = "") Constructor.
	gdsParameter (const string& Name, const string& Value, const string& Unit = "", const string& Comment = "") Constructor.

Inherited from gdsNamedDatum:

Public Fields

mutable recursivemutex mux

string unit

int level

Inherited from gdsNamedStorage:

Public Fields

string name

string comment

Public Methods

bool operator == (const gdsNamedStorage& x) const

bool operator == (const string& x) const

bool operator != (const string& x) const

bool operator != (const gdsNamedStorage& x) const

bool operator <= (const gdsNamedStorage& x) const

bool operator < (const gdsNamedStorage& x) const

bool operator < (const string& x) const

bool operator >= (const gdsNamedStorage& x) const

bool operator > (const gdsNamedStorage& x) const

Inherited from gdsDatum:

Public Classes

enum encodingtype

ascii

ascii

binary

binary

uuencode

uuencoding

base64

base64 encoding

Public Fields

typedef std::vector <int> dimension_t

gdsDataType datatype

dimension_t dimension

void* value

encodingtype encoding

Public Methods

virtual bool assignDatum(const gdsDatum& dat)

static bool encode(std::ostream& os, const char* val, int len, encodingtype ctype = base64, int indent = 0)

static bool decode(std::istream& is, char* val, int len, encodingtype ctype = base64)

static bool decode(const char* code, int codelen, char* val, int len, encodingtype ctype = base64)

static std::string codeName(encodingtype ctype)

static encodingtype code(std::string name)

gdsDatum& operator= (const gdsDatum& dat)

bool resize(int dim1, int dim2 = 0, int dim3 = 0, int dim4 = 0)

int elSize() const

int elNumber() const

int size() const

int readValues(const string& txt)

void lock(bool writeaccess = false) const

bool trylock(bool writeaccess = false) const

void unlock() const

Protected Fields

mutable readwritelock rwlock

friend std::istream& operator >> (std::istream&, gdsParameter&)

This function reads a parameter from an input stream.

Returns:

input stream

Parameters:

istream - input stream
gdsDatum - class

friend std::ostream& operator << (std::ostream&, const gdsParameter&)

This function writes the parameter to an output stream following the LigoLW XML specification.

Returns:

input stream

Parameters:

ostream - output stream
gdsDatum - class

gdsParameter()

Constructs a parameter object with no name and empty value.

Returns:

void

gdsParameter(const gdsParameter& prm)

Constructs a parameter object.

Returns:

void

gdsParameter(const string& Name, gdsDataType DataType, const void* Value, const string& Unit = "", const string& Comment = "")

Constructs a parameter object. The supplied data field is copied (the caller is responsible to free the supplied data field if necessary.

Returns:

void

Parameters:

Name - name of parameter
DataType - type of parameter
Value - pointer to a parameter value field
dim1 - number of parameter values
Unit - unit of parametr value
Comment - comment string for describing parameter

gdsParameter(const string& Name, gdsDataType DataType, const void* Value, int dim1, const string& Unit = "", const string& Comment = "")

Constructs a parameter object. The supplied data field is copied (the caller is responsible to free the supplied data field if necessary.

Returns:

void

Parameters:

Name - name of parameter
DataType - type of parameter
Value - pointer to a parameter value field
dim1 - number of parameter values
Unit - unit of parametr value
Comment - comment string for describing parameter

gdsParameter(const string& Name, const gdsDatum& Value, const string& Unit = "", const string& Comment = "")

Constructs a parameter object. The supplied data object is copied (the caller is responsible to free the supplied data field if necessary.

Returns:

void

Parameters:

Name - name of parameter
Value - data field object
Unit - unit of parametr value
Comment - comment string for describing parameter

gdsParameter(const string& Name, char Value, const string& Unit = "", const string& Comment = "")

Constructs a parameter object from a character.

Returns:

void

Parameters:

Name - name of parameter
Value - parameter value
Unit - unit of parametr value
Comment - comment string for describing parameter

gdsParameter(const string& Name, short Value, const string& Unit = "", const string& Comment = "")

Constructs a parameter object from a short integer.

Returns:

void

Parameters:

Name - name of parameter
Value - parameter value
Unit - unit of parametr value
Comment - comment string for describing parameter

gdsParameter(const string& Name, int Value, const string& Unit = "", const string& Comment = "")

Constructs a parameter object from an 32 bit integer.

Returns:

void

Parameters:

Name - name of parameter
Value - parameter value
Unit - unit of parametr value
Comment - comment string for describing parameter

gdsParameter(const string& Name, long long Value, const string& Unit = "", const string& Comment = "")

Constructs a parameter object from a 64 bit integer.

Returns:

void

Parameters:

Name - name of parameter
Value - parameter value
Unit - unit of parametr value
Comment - comment string for describing parameter

gdsParameter(const string& Name, float Value, const string& Unit = "", const string& Comment = "")

Constructs a parameter object from a single precision floating point number.

Returns:

void

Parameters:

Name - name of parameter
Value - parameter value
Unit - unit of parametr value
Comment - comment string for describing parameter

gdsParameter(const string& Name, double Value, const string& Unit = "", const string& Comment = "")

Constructs a parameter object from a double precision floating point number.

Returns:

void

Parameters:

Name - name of parameter
Value - parameter value
Unit - unit of parametr value
Comment - comment string for describing parameter

gdsParameter(const string& Name, std::complex<float> Value, const string& Unit = "", const string& Comment = "")

Constructs a parameter object from a single precision floating point complex number.

Returns:

void

Parameters:

Name - name of parameter
Value - parameter value
Unit - unit of parametr value
Comment - comment string for describing parameter

gdsParameter(const string& Name, std::complex<double> Value, const string& Unit = "", const string& Comment = "")

Constructs a parameter object from a double precision floating point complex number.

Returns:

void

Parameters:

Name - name of parameter
Value - parameter value
Unit - unit of parametr value
Comment - comment string for describing parameter

gdsParameter(const string& Name, const string& Value, const string& Unit = "", const string& Comment = "")

Constructs a parameter object from a string.

Returns:

void

Parameters:

Name - name of parameter
Value - parameter value
Unit - unit of parametr value
Comment - comment string for describing parameter

alphabetic index hierarchy of classes

Please send questions and comments to sigg_d@ligo-wa.caltech.edu

generated by doc++