libdap++  Updated for version 3.12.0
libdap::ConstraintEvaluator Class Reference

Evaluate a constraint expression.

#include <ConstraintEvaluator.h>

Collaboration diagram for libdap::ConstraintEvaluator:
Collaboration graph

Public Types

typedef std::vector< Clause * >
::const_iterator 
Clause_citer
 
typedef std::vector< Clause * >
::iterator 
Clause_iter
 
typedef std::vector< BaseType * >
::const_iterator 
Constants_citer
 
typedef std::vector< BaseType * >
::iterator 
Constants_iter
 

Public Member Functions

void append_clause (int op, rvalue *arg1, rvalue_list *arg2)
 Add a clause to a constraint expression. More...
 
void append_clause (bool_func func, rvalue_list *args)
 Add a clause to a constraint expression. More...
 
void append_clause (btp_func func, rvalue_list *args)
 Add a clause to a constraint expression. More...
 
void append_constant (BaseType *btp)
 
bool boolean_expression ()
 Does the current constraint expression return a boolean value? More...
 
Clause_iter clause_begin ()
 
Clause_iter clause_end ()
 
bool clause_value (Clause_iter &i, DDS &dds)
 
 ConstraintEvaluator ()
 
BaseTypeeval_function (DDS &dds, const string &dataset)
 Evaluate a function-valued constraint expression. More...
 
DDSeval_function_clauses (DDS &dds)
 Evaluate a function-valued constraint expression that contains several function calls. More...
 
DataDDSeval_function_clauses (DataDDS &dds)
 Evaluate a function-valued constraint expression that contains several function calls. Takes and returns a DataDDS. More...
 
bool eval_selection (DDS &dds, const string &dataset)
 Evaluate a boolean-valued constraint expression. This is main method for the evaluator ans is called by the BaseType::serialize() methods. More...
 
bool find_function (const string &name, bool_func *f) const
 Find a Boolean function with a given name in the function list. More...
 
bool find_function (const string &name, btp_func *f) const
 Find a BaseType function with a given name in the function list. More...
 
bool find_function (const string &name, proj_func *f) const
 Find a projection function with a given name in the function list. More...
 
bool function_clauses ()
 Does the current constraint expression contain function clauses. More...
 
bool functional_expression ()
 Does the current constraint expression return a BaseType pointer? This method does not evaluate the clause, it provides information to the evaluator regarding how to evaluate the clause. More...
 
void parse_constraint (const string &constraint, DDS &dds)
 Parse the constraint expression given the current DDS. More...
 
virtual ~ConstraintEvaluator ()
 

Friends

class func_name_is
 

Detailed Description

Definition at line 48 of file ConstraintEvaluator.h.

Member Typedef Documentation

typedef std::vector<Clause *>::const_iterator libdap::ConstraintEvaluator::Clause_citer

Definition at line 96 of file ConstraintEvaluator.h.

typedef std::vector<Clause *>::iterator libdap::ConstraintEvaluator::Clause_iter

Definition at line 97 of file ConstraintEvaluator.h.

typedef std::vector<BaseType *>::const_iterator libdap::ConstraintEvaluator::Constants_citer

Definition at line 99 of file ConstraintEvaluator.h.

typedef std::vector<BaseType *>::iterator libdap::ConstraintEvaluator::Constants_iter

Definition at line 100 of file ConstraintEvaluator.h.

Constructor & Destructor Documentation

libdap::ConstraintEvaluator::ConstraintEvaluator ( )

Definition at line 51 of file ConstraintEvaluator.cc.

References libdap::ServerFunctionsList::TheList().

Here is the call graph for this function:

libdap::ConstraintEvaluator::~ConstraintEvaluator ( )
virtual

Definition at line 63 of file ConstraintEvaluator.cc.

Member Function Documentation

void libdap::ConstraintEvaluator::append_clause ( int  op,
rvalue arg1,
rvalue_list arg2 
)

This function adds an operator clause to the constraint expression.

Parameters
opAn integer indicating the operator in use. These values are generated by bison.
arg1A pointer to the argument on the left side of the operator.
arg2A pointer to a list of the arguments on the right side of the operator.

Definition at line 114 of file ConstraintEvaluator.cc.

void libdap::ConstraintEvaluator::append_clause ( bool_func  func,
rvalue_list args 
)

This function adds a boolean function clause to the constraint expression.

Parameters
funcA pointer to a boolean function from the list of supported functions.
argsA list of arguments to that function.

Definition at line 130 of file ConstraintEvaluator.cc.

void libdap::ConstraintEvaluator::append_clause ( btp_func  func,
rvalue_list args 
)

This function adds a real-valued (BaseType) function clause to the constraint expression.

Parameters
funcA pointer to a BaseType function from the list of supported functions.
argsA list of arguments to that function.

Definition at line 146 of file ConstraintEvaluator.cc.

void libdap::ConstraintEvaluator::append_constant ( BaseType btp)

The Constraint Evaluator maintains a list of BaseType pointers for all the constants that the constraint expression parser generates. These objects are deleted by the Constraint Evaluator destructor. Note that there are no list accessors; these constants are never accessed from the list. The list is simply a convenient way to make sure the constants are disposed of properly.

Definition at line 160 of file ConstraintEvaluator.cc.

bool libdap::ConstraintEvaluator::boolean_expression ( )

Definition at line 416 of file ConstraintEvaluator.cc.

ConstraintEvaluator::Clause_iter libdap::ConstraintEvaluator::clause_begin ( )

Returns the first clause in a parsed constraint expression.

Definition at line 80 of file ConstraintEvaluator.cc.

ConstraintEvaluator::Clause_iter libdap::ConstraintEvaluator::clause_end ( )

Returns a reference to the end of the list of clauses in a parsed constraint expression. It does not reference the last clause

Definition at line 87 of file ConstraintEvaluator.cc.

bool libdap::ConstraintEvaluator::clause_value ( Clause_iter iter,
DDS dds 
)

Returns the value of the indicated clause of a constraint expression.

Definition at line 94 of file ConstraintEvaluator.cc.

BaseType * libdap::ConstraintEvaluator::eval_function ( DDS dds,
const string &  dataset 
)
Deprecated:

Definition at line 302 of file ConstraintEvaluator.cc.

References libdap::Clause::value().

Referenced by libdap::DODSFilter::send_data(), and libdap::DODSFilter::send_data_ddx().

Here is the call graph for this function:

DDS * libdap::ConstraintEvaluator::eval_function_clauses ( DDS dds)

This method can be called for any function-valued constraint expression. Unlike eval_function(), it will package the return value in a new DDS object. The server should free this object once it has been serialized and sent.

Note
While there is another type of function that can appear in a CE (a 'projection function') those are evaluated by the ce parser - they are used to insert new variables into the DDS as a side effect of CE evaluation. That kind of function can never appear here; these are all functions that return BaseType pointers.
Added for libdap 3.11

Definition at line 354 of file ConstraintEvaluator.cc.

References libdap::DDS::add_var_nocopy(), libdap::DDS::get_dataset_name(), libdap::DDS::get_factory(), and libdap::Clause::value().

Referenced by libdap::DODSFilter::send_data(), and libdap::DODSFilter::send_data_ddx().

Here is the call graph for this function:

DataDDS * libdap::ConstraintEvaluator::eval_function_clauses ( DataDDS dds)
Todo:
Change this so that the new variables are inserted into the original DDS object - this will allow constraints that mix simple projections with function calls. The function is responsible for setting the new variable's read_p property and this 'evaluator' sets the send_p property. The original variables would have to be removed from the original DDS for this to work or the names of the new variables would have to not clash with the original variables' names.
See Also
ConstraintEvaluator::eval_function_clauses(DataDDS &dds)
Note
Added for libdap 3.11

Definition at line 392 of file ConstraintEvaluator.cc.

References libdap::DDS::add_var_nocopy(), libdap::DDS::get_dataset_name(), libdap::DDS::get_factory(), libdap::DataDDS::get_protocol(), libdap::DataDDS::get_version(), and libdap::Clause::value().

Here is the call graph for this function:

bool libdap::ConstraintEvaluator::eval_selection ( DDS dds,
const string &  dataset 
)
bool libdap::ConstraintEvaluator::find_function ( const string &  name,
bool_func *  f 
) const

Definition at line 228 of file ConstraintEvaluator.cc.

References libdap::ServerFunctionsList::find_function().

Here is the call graph for this function:

bool libdap::ConstraintEvaluator::find_function ( const string &  name,
btp_func *  f 
) const

Definition at line 246 of file ConstraintEvaluator.cc.

References libdap::ServerFunctionsList::find_function().

Here is the call graph for this function:

bool libdap::ConstraintEvaluator::find_function ( const string &  name,
proj_func *  f 
) const

Definition at line 264 of file ConstraintEvaluator.cc.

References libdap::ServerFunctionsList::find_function().

Here is the call graph for this function:

bool libdap::ConstraintEvaluator::function_clauses ( )

This method does not evaluate the clauses, it provides information to the evaluator regarding how to evaluate the clause.

Note
Added for libdap 3.11
Returns
True if the current constraint contains function clauses, otherwise returns False

Definition at line 324 of file ConstraintEvaluator.cc.

References libdap::Clause::value_clause().

Referenced by libdap::DODSFilter::send_data(), and libdap::DODSFilter::send_data_ddx().

Here is the call graph for this function:

bool libdap::ConstraintEvaluator::functional_expression ( )
Returns
True if the clause is a function that returns a BaseType* and false otherwise
Deprecated:

Definition at line 289 of file ConstraintEvaluator.cc.

References libdap::Clause::value_clause().

Referenced by libdap::DODSFilter::send_data(), libdap::DODSFilter::send_data_ddx(), libdap::DODSFilter::send_dds(), and libdap::DODSFilter::send_ddx().

Here is the call graph for this function:

void libdap::ConstraintEvaluator::parse_constraint ( const string &  constraint,
DDS dds 
)

Evaluate the constraint expression; return the value of the expression. As a side effect, mark the DDS so that BaseType's mfuncs can be used to correctly read the variable's value and send it to the client.

Parameters
constraintA string containing the constraint expression.
ddsThe DDS that provides the environment within which the constraint is evaluated.
Exceptions
ThrowsError if the constraint does not parse.

Definition at line 470 of file ConstraintEvaluator.cc.

References ce_expr_delete_buffer(), ce_expr_string(), ce_expr_switch_to_buffer(), ce_exprdebug, and ce_exprparse().

Referenced by libdap::DODSFilter::send_data(), libdap::DODSFilter::send_data_ddx(), libdap::DODSFilter::send_dds(), and libdap::DODSFilter::send_ddx().

Here is the call graph for this function:

Friends And Related Function Documentation

friend class func_name_is
friend

Definition at line 93 of file ConstraintEvaluator.h.


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