bes  Updated for version 3.17.4
functions::GSEClause Class Reference

#include <GSEClause.h>

Public Member Functions

bool OK () const
 
Constructors
 GSEClause (libdap::Grid *grid, const string &map, const double value, const relop op)
 
 GSEClause (libdap::Grid *grid, const string &map, const double value1, const relop op1, const double value2, const relop op2)
 
Accessors
libdap::Array * get_map () const
 Get a pointer to the map variable constrained by this clause. More...
 
string get_map_name () const
 Get the name of the map variable constrained by this clause. More...
 
int get_start () const
 Get the starting index of the clause's map variable as constrained by this clause. More...
 
int get_stop () const
 Get the stopping index of the clause's map variable as constrained by this clause. More...
 
string get_map_min_value () const
 Get the minimum map vector value. More...
 
string get_map_max_value () const
 Get the maximum map vector value. More...
 
Mutators
void set_map (libdap::Array *map)
 Set the pointer to the map vector contrained by this clause. More...
 
void set_start (int start)
 Set the starting index. More...
 
void set_stop (int stop)
 Set the stopping index. More...
 

Detailed Description

Holds the results of parsing one of the Grid Selection Expression clauses. The Grid selection function takes a set of clauses as arguments and must create one instance of this class for each of those clauses. The GridSelectionExpr class holds N instances of this class.

Author
James Gallagher
See also
GridSelectionExpr

Definition at line 73 of file GSEClause.h.

Member Function Documentation

◆ get_map()

Array * functions::GSEClause::get_map ( ) const
Returns
The Array object.

Definition at line 251 of file GSEClause.cc.

◆ get_map_max_value()

string functions::GSEClause::get_map_max_value ( ) const

Useful in messages back to users.

Returns
The maximum map vetor value.

Definition at line 324 of file GSEClause.cc.

◆ get_map_min_value()

string functions::GSEClause::get_map_min_value ( ) const

Useful in messages back to users.

Returns
The minimum map vetor value.

Definition at line 314 of file GSEClause.cc.

◆ get_map_name()

string functions::GSEClause::get_map_name ( ) const
Returns
The Array object's name.

Definition at line 269 of file GSEClause.cc.

◆ get_start()

int functions::GSEClause::get_start ( ) const
Returns
The start index.

Definition at line 278 of file GSEClause.cc.

◆ get_stop()

int functions::GSEClause::get_stop ( ) const
Returns
The stop index.

Definition at line 295 of file GSEClause.cc.

◆ OK()

bool functions::GSEClause::OK ( ) const

Class invariant.

Returns
True if the object is valid, otherwise False.

Definition at line 238 of file GSEClause.cc.

◆ set_map()

void functions::GSEClause::set_map ( libdap::Array *  map)

Note that this method also sets the name of the map vector.

Returns
void

Definition at line 261 of file GSEClause.cc.

◆ set_start()

void functions::GSEClause::set_start ( int  start)
Returns
void

Definition at line 286 of file GSEClause.cc.

◆ set_stop()

void functions::GSEClause::set_stop ( int  stop)
Returns
void

Definition at line 304 of file GSEClause.cc.


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