class Function

Defines an event

Inheritance:

Public Methods

	Function () Default constructor
virtual	~Function () Denstructor
virtual Function*	Copy () const Copy the event function
virtual bool	Evaluate (const Argument& arg, Value& val) const Function value
bool	operator) (const Argument& arg, Value& val) const () operator
bool	operator) (const Event& event, Value& val) const () operator

Protected Methods

	Function (const Function&) Copy constructor
Function&	operator= (const Function&) Assignment operator

Function()

Creates an event function.

virtual ~Function()

Destructs an event function.

virtual Function* Copy() const

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

Returns:

event function copy

virtual bool Evaluate(const Argument& arg, Value& val) const

Returns the value of the function. This function must be overriden by descendents. The function returns true if it could be evaluated and false otherwise.

Returns:

True if function could be evaluated

Parameters:

arg - Event argument list
val - value (return)

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

Function call operator. Returns the same as Evaluate (should not be overriden).

Returns:

True if function could be evaluated

Parameters:

arg - Event argument list
val - Value (return)

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

Function call operator. Evaluates a function on a single event (should not be overriden).

Returns:

True if function could be evaluated

Parameters:

arg - Event argument list
val - Value (return)

Function(const Function&)

Copy constructor. This is almost never intended, so just disable it from the outside.

Function& operator= (const Function&)

Assignment operator. This is almost never intended, so just disable it from the outside.

Direct child classes:

Value
ShiftFunction
Math
Info
TVal
SVal
RVal
IVal
CVal
Column

Author:

Written June 2001 by Masahiro Ito and Daniel Sigg

Version:

1.0

alphabetic index hierarchy of classes

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

generated by doc++