Defines an event value

Inheritance:

Public Fields

static const int

kMaxValueSize Maximum data size

Public Methods

	Value () Default constructor
	Value (const Value& val) Copy constructor
	~Value () Denstructor
Value&	operator= (const Value& val) Assignment operator
virtual Value*	Copy () const Copy the event function
	Value (Real x) Default constructor
	Value (Int i) Constructor (int)
	Value (const Time& t) Constructor (Time)
	Value (const Complex& c) Constructor (complex)
	Value (const String& s) Constructor (string)
	Value (const char* s, int len = -1) Constructor (string)
	Value (const Event& e) Constructor (event)
	Value (Enum type, const void* p) Constructor (specified type)
bool	Write (Real& x) const Get value
bool	Write (Int& i) const Get value
bool	Write (Complex& c) const Get value
bool	Write (Time& t) const Get value
bool	Write (std::string& s) const Get value
bool	Write (char* p, int& len) const Get value
bool	Write (Event& e) const Get value
bool	Write (Enum type, data_ptr p) const Get value
bool	Read (Real x) Set value
bool	Read (Int i) Set value
bool	Read (const Complex& x) Set value
bool	Read (const Time& t) Set value
bool	Read (const std::string& s) Set value
bool	Read (const char* p, int len = -1) Set value
bool	Read (const Event& e) Set value
bool	Read (Enum type, const_data_ptr p) Set value
valuetype	Type () const Value type
virtual bool	Evaluate (const Argument&, Value& x) const Function value
Value&	operator += (const Value& val) Value math (plus equal)
Value&	operator -= (const Value& val) Value math (minus equal)
Value&	operator *= (const Value& val) Value math (times equal)
Value&	operator /= (const Value& val) Value math (over equal)
Value&	operator %= (const Value& val) Value math (mod equal)
Value&	operator |= (const Value& val) Value math (or equal)
Value&	operator &= (const Value& val) Value math (and equal)
Value&	operator ^= (const Value& val) Value math (xor equal)
Value&	operator >>= (const Value& val) Value math (shift right)
Value&	operator <<= (const Value& val) Value math (shift left equal)

Public Members

typedef ColumnType::Enum	valuetype Value type
union	Union Value union

Inherited from Function:

Public Methods

bool operator() (const Argument& arg, Value& val) const

bool operator() (const Event& event, Value& val) const

Documentation

The event value class contains the number value including its type. Typically, the values of event columns are returned as event values. A value is also a constant function!

typedef ColumnType::Enum valuetype

Value type

union Union

Value union

static const int kMaxValueSize

Maximum data size

Value()

Creates an event value.

Value(const Value& val)

Copy constructor.

~Value()

Destructs an event argument.

Value& operator= (const Value& val)

Assignment operator.

virtual Value* Copy() const

Returns a copy of the event function. This method must be overriden by all descendents.

Returns:

event function copy

Value(Real x)

Creates an event value.

Value(Int i)

Creates an event value.

Value(const Time& t)

Creates an event value.

Value(const Complex& c)

Creates an event value.

Value(const String& s)

Creates an event value.

Value(const char* s, int len = -1)

Creates an event value. If the length argument is negative the strlen function is used to determine the length of the data.

Value(const Event& e)

Creates an event value.

Value(Enum type, const void* p)

Creates an event value.

bool Write(Real& x) const

Get value in real format.

Returns:

True if conversion possible

bool Write(Int& i) const

Get value in int format.

Returns:

True if conversion possible

bool Write(Complex& c) const

Get value in complex format.

Returns:

True if conversion possible

bool Write(Time& t) const

Get value in Time format.

Returns:

True if conversion possible

bool Write(std::string& s) const

Get value in string format.

Returns:

True if conversion possible

bool Write(char* p, int& len) const

Get value in string format. The length has to be set to the maximum size of the character buffer p before the call. It will return the actual length of the string (non counting a terminating NULL character). The returned string is always NULL terminated regardless whether the string contains ASCII or binary data. Do not use strlen to determine the length of the string if it contains binary data!

Returns:

True if conversion possible

bool Write(Event& e) const

Get value in event format.

Returns:

True if conversion possible

bool Write(Enum type, data_ptr p) const

Get value in the specified format.

Returns:

True if conversion possible

bool Read(Real x)

Set value in real format.

Returns:

True if conversion possible

bool Read(Int i)

Set value in int format.

Returns:

True if conversion possible

bool Read(const Complex& x)

Set value in complex format.

Returns:

True if conversion possible

bool Read(const Time& t)

Set value in Time format.

Returns:

True if conversion possible

bool Read(const std::string& s)

Set value in string format.

Returns:

True if conversion possible

bool Read(const char* p, int len = -1)

Set value in string format. If the length argument is negative the strlen function is used to determine the length of the data.

Returns:

True if conversion possible

bool Read(const Event& e)

Set value in event format.

Returns:

True if conversion possible

bool Read(Enum type, const_data_ptr p)

Set value in the specified format. If the data pointer is null, the value is set to the default value of this type.

Returns:

True if conversion possible

valuetype Type() const

Type of value.

virtual bool Evaluate(const Argument&, Value& x) const

A value is a constant function.

Parameters:

- arg Event argument list
x - value (return)

Returns:

True if function could be evaluated

Value& operator += (const Value& val)

Math operator for value (plus equal).

Returns:

itself

Value& operator -= (const Value& val)

Math operator for value (minus equal).

Returns:

itself

Value& operator *= (const Value& val)

Math operator for value (times equal).

Returns:

itself

Value& operator /= (const Value& val)

Math operator for value (over equal).

Returns:

itself

Value& operator %= (const Value& val)

Math operator for value (mod equal).

Returns:

itself

Value& operator |= (const Value& val)

Math operator for value (or equal).

Returns:

itself

Value& operator &= (const Value& val)

Math operator for value (and equal).

Returns:

itself

Value& operator ^= (const Value& val)

Math operator for value (xor equal).

Returns:

itself

Value& operator >>= (const Value& val)

Math operator for value (shift right equal).

Returns:

itself

Value& operator <<= (const Value& val)

Math operator for value (shift left equal).

Returns:

itself

Direct child classes:

IfoVal

Author:

Written June 2001 by Masahiro Ito and Daniel Sigg

Version:

1.0

Alphabetic index HTML hierarchy of classes or Java

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