class diagIndex : public diagObject

Manager class for the index.

Inheritance:

Public Fields

static const string	indexIndent indent for index entries
static const string	indexCat category separator
static const string	indexEqual index entry equal sign
static const string	indexEnd index entry delimiter
typedef std::map <string, int>	masterindex master index type

Public Methods

	diagIndex () Default constructor.
static const diagIndex&	self () Reference object.
bool	isCategory (const string& cat, int step, string* catname = 0) const Chack index category method.
bool	getMasterIndex (gdsDataObject& obj, masterindex& index) const Get master index method.
bool	setMasterIndex (gdsDataObject& obj, const masterindex& index) const Set master index method.
bool	setEntry (gdsDataObject& obj, const string& category, int step, const string& entry) const Set entry method.
bool	getEntry (gdsDataObject& obj, const string& category, int step, string& entry) const Get entry method.
bool	delEntry (gdsDataObject& obj, const string& category, int step) const Delete entry method.
static std::ostream&	channelEntry (std::ostream& os, int num, const string& name, char type = ' ') Write channel entry method.
static std::ostream&	resultEntry (std::ostream& os, int res, int ofs, int len, int i1, int i2 = -1) Write result entry method.

Inherited from diagObject:

Public Classes

class diagParam: public diagObjectName

friend class diagObject

Data storage object is a friend.

diagParam(const string& Name, int MaxIndex1, int MaxIndex2, gdsDataType Datatype, const void* DefValue, int MaxDim = 1, const string& Unit = "", bool write = true)

Constructor.

virtual gdsParameter* newParam(const void* value, int dim = 1, int index1 = -1, int index2 = -1) const

New parameter method.

virtual gdsParameter* newParam(const gdsDatum& value, int index1 = -1, int index2 = -1) const

New parameter method.

Public Fields

typedef gdsDataObject::objflag objflag

Public Methods

virtual bool isValid(const string& Name, bool write = true, string* normName = 0) const

virtual gdsDataObject* newObject(void* value, int dim1 = 0, int dim2 = 0, int index1 = -1, int index2 = -1, gdsDataType Datatype = gds_void) const

virtual bool clone(gdsDataObject& obj, const gdsDataObject* templ, bool copydata = true) const

virtual bool setParamHook(gdsDataObject& obj, const string& pName, const gdsDatum& value) const

virtual bool getParamHook(gdsDataObject& obj, const string& pName, gdsDatum& value) const

virtual bool setParam(gdsDataObject& obj, const string& pName, const gdsDatum& value) const

virtual bool setParam(gdsDataObject& obj, const string& pName, const string& value) const

virtual bool setParam(gdsDataObject& obj, const string& pName, char value) const

virtual bool setParam(gdsDataObject& obj, const string& pName, short value) const

virtual bool setParam(gdsDataObject& obj, const string& pName, int value) const

virtual bool setParam(gdsDataObject& obj, const string& pName, long long value) const

virtual bool setParam(gdsDataObject& obj, const string& pName, float value) const

virtual bool setParam(gdsDataObject& obj, const string& pName, double value) const

virtual bool setParam(gdsDataObject& obj, const string& pName, std::complex<float> value) const

virtual bool setParam(gdsDataObject& obj, const string& pName, std::complex<double> value) const

virtual bool setParam(gdsDataObject& obj, const string& pName, bool value) const

virtual bool getParam(gdsDataObject& obj, const string& pName, gdsDatum& value) const

virtual bool getParam(gdsDataObject& obj, const string& pName, string& value) const

virtual bool getParam(gdsDataObject& obj, const string& pName, char& value) const

virtual bool getParam(gdsDataObject& obj, const string& pName, short& value) const

virtual bool getParam(gdsDataObject& obj, const string& pName, int& value, int max = 1) const

virtual bool getParam(gdsDataObject& obj, const string& pName, long long& value) const

virtual bool getParam(gdsDataObject& obj, const string& pName, float& value) const

virtual bool getParam(gdsDataObject& obj, const string& pName, double& value, int max = 1) const

virtual bool getParam(gdsDataObject& obj, const string& pName, std::complex<float>& value) const

virtual bool getParam(gdsDataObject& obj, const string& pName, std::complex<double>& value) const

virtual bool getParam(gdsDataObject& obj, const string& pName, bool& value) const

virtual bool setData(gdsDataObject& obj, const void* value, int dim1 = 0, int dim2 = 0, gdsDataType Datatype = gds_void) const

string getType() const

objflag getFlag() const

Protected Fields

typedef std::vector <diagParam> diagParamList

diagParamList dParams

objflag flag

string type

Inherited from diagObjectName:

Public Methods

static string makeName(const string& Name, int index1 = -1, int index2 = -1)

Protected Fields

string name

int maxIndex1

int maxIndex2

gdsDataType datatype

int maxDim1

int maxDim2

const void* defValue

string unit

bool writeaccess

static const string indexIndent

indent for index entries

static const string indexCat

category separator

static const string indexEqual

index entry equal sign

static const string indexEnd

index entry delimiter

typedef std::map <string, int> masterindex

master index type

diagIndex()

Constructs an access object for the index.

Returns:

void

static const diagIndex& self()

Returns a const reference to an object of itself.

Returns:

reference object

bool isCategory(const string& cat, int step, string* catname = 0) const

Checks if index category is valid.

Returns:

true if valid

Parameters:

cat - category name
step - step number of category (-1 = none)
catname - canonical category name with step index (return)

bool getMasterIndex(gdsDataObject& obj, masterindex& index) const

Get master index method.

Returns:

true if successful

Parameters:

obj - data object
index - master index (return)

bool setMasterIndex(gdsDataObject& obj, const masterindex& index) const

Set master index method.

Returns:

true if successful

Parameters:

obj - data object
index - master index

bool setEntry(gdsDataObject& obj, const string& category, int step, const string& entry) const

Sets a new entry of specified category.

Returns:

true if successful

Parameters:

obj - data object
category - index entry type
step - step number of category (-1 = none)
entry - index entry string

bool getEntry(gdsDataObject& obj, const string& category, int step, string& entry) const

Gets the entry of the specified category.

Returns:

true if successful

Parameters:

obj - data object
category - index entry type
step - step number of category (-1 = none)
entry - index entry string (return)

bool delEntry(gdsDataObject& obj, const string& category, int step) const

Deletes the entry of the specified category.

Returns:

true if successful

Parameters:

obj - data object
category - index entry type
step - step number of category (-1 = none)

static std::ostream& channelEntry(std::ostream& os, int num, const string& name, char type = ' ')

Writes a channel entry to the stream.

Returns:

output stream

Parameters:

os - output stream
num - channel number
name - channel name
type - type of channel: 'A', 'B' or ' '

static std::ostream& resultEntry(std::ostream& os, int res, int ofs, int len, int i1, int i2 = -1)

Writes a result entry to the stream.

Returns:

output stream

Parameters:

os - output stream
res - index of result object
ofs - data offset
len - data length
i1 - first index of entry
i1 - second index of entry

alphabetic index hierarchy of classes

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

generated by doc++