class gdsDataObject : public gdsNamedDatum

Class to store a data object.

Inheritance:

Public Classes

enum	objflag flags for describing a data object; used for save/restore parameterObj global diganostics test parameters settingsObj the user settings of a diagnostics test resultObj results of a diganotics test rawdataObj the raw data of a diagnostics test imageObj the plots of a diagnostics test

Public Fields

typedef std::vector <gdsParameterPtr>	gdsParameterList list of pointers to parameter objects
gdsParameterList	parameters list of parameters asscoaited with the data object
gdsDataReference	link link object for referencing binary data objects
bool	error Error flag

Public Methods

friend std::istream&	operator >> (std::istream&, gdsDataObject&) Input operator.
friend std::ostream&	operator << (std::ostream&, const gdsDataObject&) Output operator.
	gdsDataObject () Default constructor.
	gdsDataObject (const gdsDataObject& dat) Copy constructor.
	gdsDataObject (const string& Name, gdsDataType DataType, const void* Value, const string& Unit = "", const string& Comment = "", objflag Flag = resultObj) Constructor.
	gdsDataObject (const string& Name, gdsDataType DataType, const void* Value, int dim1, const string& Unit = "", const string& Comment = "", objflag Flag = resultObj) Constructor.
	gdsDataObject (const string& Name, gdsDataType DataType, const void* Value, int dim1, int dim2, const string& Unit = "", const string& Comment = "", objflag Flag = resultObj) Constructor.
	gdsDataObject (const string& Name, gdsDataType DataType, const void* Value, int dim1, int dim2, int dim3, const string& Unit = "", const string& Comment = "", objflag Flag = resultObj) Constructor.
	gdsDataObject (const string& Name, gdsDataType DataType, const void* Value, int dim1, int dim2, int dim3, int dim4, const string& Unit = "", const string& Comment = "", objflag Flag = resultObj) Constructor.
virtual	~gdsDataObject () Destructor.
gdsDataObject&	operator= (const gdsDataObject& dat) Copy operator.
virtual bool	assignDatum (const gdsDatum& dat) Assignment.
static objflag	gdsObjectFlag (const string& oflag) Object flag from name.
static string	gdsObjectFlagName (objflag oflag) Object flag name
string	getType () const Get type.
objflag	getFlag () const Get flag.
void	setType (const string& otype) Set type.
void	setFlag (objflag oflag) Set flag.
void	setFlag (const string& oflag) Set flag.
bool	isRef () const Checks if reference to binary data.

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

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)

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&, gdsDataObject&)

This function reads the data object from an input stream.

Returns:

input stream

Parameters:

istream - input stream
gdsDataObject - class

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

This function writes a data object to an output stream following the LigoLW XML specification.

Returns:

input stream

Parameters:

ostream - output stream
gdsDataObject - class

typedef std::vector <gdsParameterPtr> gdsParameterList

list of pointers to parameter objects

enum objflag

flags for describing a data object; used for save/restore

parameterObj

global diganostics test parameters

settingsObj

the user settings of a diagnostics test

resultObj

results of a diganotics test

rawdataObj

the raw data of a diagnostics test

imageObj

the plots of a diagnostics test

gdsParameterList parameters

list of parameters asscoaited with the data object

gdsDataReference link

link object for referencing binary data objects

bool error

Error flag

gdsDataObject()

Constructs a data object with no name and empty value.

Returns:

void

gdsDataObject(const gdsDataObject& dat)

Constructs a data object from an other one.

Returns:

void

gdsDataObject(const string& Name, gdsDataType DataType, const void* Value, const string& Unit = "", const string& Comment = "", objflag Flag = resultObj)

Constructs a data 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 data object
DataType - type of data object
Value - pointer to a data value field
Unit - unit of data value
Comment - comment string for describing data object
flag - type of data object

gdsDataObject(const string& Name, gdsDataType DataType, const void* Value, int dim1, const string& Unit = "", const string& Comment = "", objflag Flag = resultObj)

Constructs a data 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 data object
DataType - type of data object
Value - pointer to a data value field
dim1 - number of data values
Unit - unit of data value
Comment - comment string for describing data object
flag - type of data object

gdsDataObject(const string& Name, gdsDataType DataType, const void* Value, int dim1, int dim2, const string& Unit = "", const string& Comment = "", objflag Flag = resultObj)

Constructs a data 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 data object
DataType - type of data object
Value - pointer to a data value field
dim1 - first dimension of data array
dim2 - second dimension of data array
Unit - unit of data value
Comment - comment string for describing data object
flag - type of data object

gdsDataObject(const string& Name, gdsDataType DataType, const void* Value, int dim1, int dim2, int dim3, const string& Unit = "", const string& Comment = "", objflag Flag = resultObj)

Constructs a data 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 data object
DataType - type of data object
Value - pointer to a data value field
dim1 - first dimension of data array
dim2 - second dimension of data array
dim3 - third dimension of data array
Unit - unit of data value
Comment - comment string for describing data object
flag - type of data object

gdsDataObject(const string& Name, gdsDataType DataType, const void* Value, int dim1, int dim2, int dim3, int dim4, const string& Unit = "", const string& Comment = "", objflag Flag = resultObj)

Constructs a data 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 data object
DataType - type of data object
Value - pointer to a data value field
dim1 - first dimension of data array
dim2 - second dimension of data array
dim3 - third dimension of data array
dim4 - fourth dimension of data array
Unit - unit of data value
Comment - comment string for describing data object
flag - type of data object

virtual ~gdsDataObject()

Denstructs the data object.

Returns:

void

gdsDataObject& operator= (const gdsDataObject& dat)

Copies a data object from an other one.

Returns:

data object

virtual bool assignDatum(const gdsDatum& dat)

Copies a data field.

Returns:

this data field

Parameters:

gdsDatum - data field which will be copied

static objflag gdsObjectFlag(const string& oflag)

Returns the object flag from its name.

Returns:

object flag

Parameters:

oflag - object name

static string gdsObjectFlagName(objflag oflag)

Returns the object name from its flag.

Returns:

object flag name

Parameters:

oflag - object flag

string getType() const

Gets the object type.

Returns:

object type

objflag getFlag() const

Gets the object flag.

Returns:

object flag

void setType(const string& otype)

Sets the object type.

Returns:

void

Parameters:

object - type

void setFlag(objflag oflag)

Sets the object flag.

Returns:

void

Parameters:

object - flag

void setFlag(const string& oflag)

Sets the object flag.

Returns:

void

Parameters:

object - flag name

bool isRef() const

Returns true if the data object maintains a link to a file containing binary data.

Returns:

true if binary data is referenced, false otherwise

Direct child classes:

gdsStorage

Author:

DS, November 98

See Also:

Diagnostics storage API

alphabetic index hierarchy of classes

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

generated by doc++