ETBooleanExpr Class Reference

This abstract class defines the basic functionalities of any Boolean expression (AKA: Filter). More...

Inherits Simba::SQLEngine::ETExpr.

List of all members.

Classes

class  ScopedOpen

Public Member Functions

virtual ETBoolean Evaluate ()=0
 Evaluate the Boolean expression. This is the main functionality of any Boolean expression.
simba_double32 GetFilterFactor ()
 Get the filter factor.
virtual void Open ()=0
 Open the node for execution.
virtual void Reset ()
 Resets this Boolean expression. Depends on the specific Boolean expression type, this might have very different meanings. In general, however, this means setting the status of a node to its initial state, just as it is just created.
void SetFilterFactor (simba_double32 in_filterFactor)
 Set the filter factor.
virtual ~ETBooleanExpr ()
 Destructor.

Static Public Attributes

static const simba_double32 s_defaultFilterFactor
 The default filter factor value. It is mainly for initialization.

Protected Member Functions

 ETBooleanExpr ()
 Default constructor.

Protected Attributes

simba_double32 m_filterFactor
 The filter factor.

Detailed Description

This abstract class defines the basic functionalities of any Boolean expression (AKA: Filter).


Constructor & Destructor Documentation

virtual ~ETBooleanExpr (  )  [virtual]

Destructor.

ETBooleanExpr (  )  [protected]

Default constructor.

Made it protected since this is an abstract class.


Member Function Documentation

virtual ETBoolean Evaluate (  )  [pure virtual]

Evaluate the Boolean expression. This is the main functionality of any Boolean expression.

Returns:
the evaluation result.
simba_double32 GetFilterFactor (  )  [inline]

Get the filter factor.

Returns:
the filter factor.
virtual void Open (  )  [pure virtual]

Open the node for execution.

For most of the expression nodes, this normally means preparing the operands. (i.e., call the Open() methods on the operands.)

Exceptions:
SESqlErrorException if an error occurs.
virtual void Reset (  )  [inline, virtual]

Resets this Boolean expression. Depends on the specific Boolean expression type, this might have very different meanings. In general, however, this means setting the status of a node to its initial state, just as it is just created.

This default implementation does nothing. Override this function in subclasses where appropriate.

Implements ETExpr.

void SetFilterFactor ( simba_double32  in_filterFactor  )  [inline]

Set the filter factor.

Parameters:
in_filterFactor The filter factor for the expression.

Member Data Documentation

simba_double32 m_filterFactor [protected]

The filter factor.

const simba_double32 s_defaultFilterFactor [static]

The default filter factor value. It is mainly for initialization.

The default filter factor assumes nothing will be filtered out. In other words, it is the least effective filtering.


The documentation for this class was generated from the following file:

Generated on Wed May 17 14:21:18 2017 for SimbaEngine 10.1.3.1011 by simba