Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages

DataValue Class Reference
[Datastructures]

#include <OpenMS/DATASTRUCTURES/DataValue.h>

List of all members.


Detailed Description

Class to hold a string or numeric value (UInt, Int, Real, DoubleReal).


Public Types

enum  DataType { STRING_VALUE, INT_VALUE, DOUBLE_VALUE, EMPTY_VALUE }
 Supported types for DataValue. More...

Public Member Functions

DataType valueType () const
 returns the type of value stored
DataValueoperator= (const DataValue &)
 assignment operator
bool isEmpty () const
 test if the value is empty
Coinstructors and destructors
 DataValue ()
 default constructor
 DataValue (const char *)
 specific constructor for char* (converted to string)
 DataValue (const String &)
 specific constructor for String
 DataValue (DoubleReal)
 specific constructor for DoubleReal
 DataValue (Real)
 specific constructor for Real
 DataValue (Int)
 specific constructor for Int
 DataValue (UInt)
 specific constructor for UInt
 DataValue (const DataValue &)
 copy constructor
virtual ~DataValue ()
 destructor
cast operators
These methods are used when the DataType is known. If they are applied to a DataValue with the wrong DataType, an exception is thrown.

 operator std::string () const throw (Exception::ConversionError)
 conversion operator to string
 operator DoubleReal () const throw (Exception::ConversionError)
 conversion operator to double
 operator Real () const throw (Exception::ConversionError)
 conversion operator to float
 operator Int () const throw (Exception::ConversionError)
 conversion operator to int
 operator UInt () const throw (Exception::ConversionError)
 conversion operator to unsigned int
const char * toChar () const throw (Exception::ConversionError)
 Convert DataValues to char*.
conversion operators
These methods can be used independent of the DataType. If you already know the DataType, you should use a cast operator!
For conversion of string DataValues to numeric types, first use toString() and then the conversion methods of String.

String toString () const
 Conversion to String.
QString toQString () const
 Conversuin to QString.

Static Public Attributes

static const DataValue EMPTY
 Empty data value for comparisons.

Protected Attributes

DataType value_type_
 Type of the currently stored value.
union {
   PointerSizeInt   int_
   DoubleReal   dou_
   String *   str_
data_

Friends

std::ostream & operator<< (std::ostream &, const DataValue &)
 output stream operator
bool operator== (const DataValue &, const DataValue &)
 Equality comparator.
bool operator!= (const DataValue &, const DataValue &)
 Equality comparator.

Member Enumeration Documentation

enum DataType

Supported types for DataValue.

Enumerator:
STRING_VALUE  String value.
INT_VALUE  UInt/Int value.
DOUBLE_VALUE  DoubleReal/Real value.
EMPTY_VALUE  Empty value.


Constructor & Destructor Documentation

DataValue (  ) 

default constructor

DataValue ( const char *   ) 

specific constructor for char* (converted to string)

DataValue ( const String  ) 

specific constructor for String

DataValue ( DoubleReal   ) 

specific constructor for DoubleReal

DataValue ( Real   ) 

specific constructor for Real

DataValue ( Int   ) 

specific constructor for Int

DataValue ( UInt   ) 

specific constructor for UInt

DataValue ( const DataValue  ) 

copy constructor

virtual ~DataValue (  )  [virtual]

destructor


Member Function Documentation

operator std::string (  )  const throw (Exception::ConversionError)

conversion operator to string

operator DoubleReal (  )  const throw (Exception::ConversionError)

conversion operator to double

operator Real (  )  const throw (Exception::ConversionError)

conversion operator to float

operator Int (  )  const throw (Exception::ConversionError)

conversion operator to int

operator UInt (  )  const throw (Exception::ConversionError)

conversion operator to unsigned int

const char* toChar (  )  const throw (Exception::ConversionError)

Convert DataValues to char*.

If the DataValue contains a string, a pointer to it's char* is returned. If the DataValue is empty, NULL is returned.

String toString (  )  const

Conversion to String.

QString toQString (  )  const

Conversuin to QString.

DataType valueType (  )  const [inline]

returns the type of value stored

DataValue& operator= ( const DataValue  ) 

assignment operator

bool isEmpty (  )  const [inline]

test if the value is empty


Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  ,
const DataValue  
) [friend]

output stream operator

bool operator== ( const DataValue ,
const DataValue  
) [friend]

Equality comparator.

bool operator!= ( const DataValue ,
const DataValue  
) [friend]

Equality comparator.


Member Data Documentation

const DataValue EMPTY [static]

Empty data value for comparisons.

DataType value_type_ [protected]

Type of the currently stored value.

PointerSizeInt int_

DoubleReal dou_

String* str_

union { ... } data_ [protected]


The documentation for this class was generated from the following file:
Generated Tue Apr 1 15:36:43 2008 -- using doxygen 1.5.4 OpenMS / TOPP 1.1