In file gdsdatum.h:

class gdsNamedStorage

Class to store a name and a comment.

Inheritance:


Public Fields

string name
Describes the name of a storage object.
string comment
Contains a comment string.

Public Methods

explicit gdsNamedStorage (const string& Name = "", const string& Comment = "")
Default constructor.
bool operator == (const gdsNamedStorage& x) const
Equality operator.
bool operator == (const string& x) const
Equality operator.
bool operator != (const string& x) const
Inquality operator.
bool operator != (const gdsNamedStorage& x) const
Inequality operator.
bool operator <= (const gdsNamedStorage& x) const
Less or equal operator.
bool operator < (const gdsNamedStorage& x) const
Less than operator.
bool operator < (const string& x) const
Less than operator.
bool operator >= (const gdsNamedStorage& x) const
Greater or equal operator.
bool operator > (const gdsNamedStorage& x) const
Greater than operator.

Documentation

This class is used to give a storage object a name. One can also add a comment string.
string name
Describes the name of a storage object.

string comment
Contains a comment string.

explicit gdsNamedStorage(const string& Name = "", const string& Comment = "")
Constructs a named storage object with name and a comment string. Default values for name and comment are empty strings.
Returns:
void
Parameters:
Name - name of the storage object (default "")
Comment - comment string (default "")

bool operator == (const gdsNamedStorage& x) const
Compares the name of two named storage objects (equal). The comparison is not case sensitive.
Returns:
true if equal, false otherwise
Parameters:
x - named storage object

bool operator == (const string& x) const
Compares the name of a named storage objects to a string (equal). The comparison is not case sensitive.
Returns:
true if equal, false otherwise
Parameters:
x - string

bool operator != (const string& x) const
Compares the name of a named storage objects to a string (equal). The comparison is not case sensitive.
Returns:
true if equal, false otherwise
Parameters:
x - string

bool operator != (const gdsNamedStorage& x) const
Compares the name of a named storage object to a string (unequal). The comparison is not case sensitive.
Returns:
true if unequal, false otherwise
Parameters:
x - named storage object

bool operator <= (const gdsNamedStorage& x) const
Compares the name of two named storage objects (less or equal). The comparison is not case sensitive.
Returns:
true if less or equal, false otherwise
Parameters:
x - named storage object

bool operator < (const gdsNamedStorage& x) const
Compares the name of a named storage object to a string (less). The comparison is not case sensitive.
Returns:
true if less, false otherwise
Parameters:
x - named storage object

bool operator < (const string& x) const
Compares the name of two named storage objects (less). The comparison is not case sensitive.
Returns:
true if less, false otherwise
Parameters:
x - named storage object

bool operator >= (const gdsNamedStorage& x) const
Compares the name of two named storage objects (greater of equal). The comparison is not case sensitive.
Returns:
true if greater or equal, false otherwise
Parameters:
x - named storage object

bool operator > (const gdsNamedStorage& x) const
Compares the name of two named storage objects (greater). The comparison is not case sensitive.
Returns:
true if greater, false otherwise
Parameters:
x - named storage object


Direct child classes:
gdsNamedDatum
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++