libdap Updated for version 3.21.1
libdap4 is an implementation of OPeNDAP's DAP protocol.
functions::GSEClause Class Reference

#include <GSEClause.h>

Collaboration diagram for functions::GSEClause:
Collaboration graph

Public Member Functions

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)
 
virtual ~GSEClause ()
 
bool OK () const
 
Accessors
libdap::Arrayget_map () const
 Get a pointer to the map variable constrained by this clause.
 
string get_map_name () const
 Get the name of the map variable constrained by this clause.
 
int get_start () const
 Get the starting index of the clause's map variable as constrained by this clause.
 
int get_stop () const
 Get the stopping index of the clause's map variable as constrained by this clause.
 
string get_map_min_value () const
 Get the minimum map vector value.
 
string get_map_max_value () const
 Get the maximum map vector value.
 
Mutators
void set_map (libdap::Array *map)
 Set the pointer to the map vector contrained by this clause.
 
void set_start (int start)
 Set the starting index.
 
void set_stop (int stop)
 Set the stopping index.
 

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 72 of file GSEClause.h.

Constructor & Destructor Documentation

◆ GSEClause() [1/2]

functions::GSEClause::GSEClause ( libdap::Grid * grid,
const string & map,
const double value,
const relop op )

◆ GSEClause() [2/2]

functions::GSEClause::GSEClause ( libdap::Grid * grid,
const string & map,
const double value1,
const relop op1,
const double value2,
const relop op2 )

◆ ~GSEClause()

functions::GSEClause::~GSEClause ( )
virtual

Definition at line 207 of file GSEClause.cc.

Member Function Documentation

◆ get_map()

Array * functions::GSEClause::get_map ( ) const

Get a pointer to the map variable constrained by this clause.

Returns
The Array object.

Definition at line 222 of file GSEClause.cc.

◆ get_map_max_value()

string functions::GSEClause::get_map_max_value ( ) const

Get the maximum map vector value.

Useful in messages back to users.

Returns
The maximum map vetor value.

Definition at line 265 of file GSEClause.cc.

◆ get_map_min_value()

string functions::GSEClause::get_map_min_value ( ) const

Get the minimum map vector value.

Useful in messages back to users.

Returns
The minimum map vetor value.

Definition at line 259 of file GSEClause.cc.

◆ get_map_name()

string functions::GSEClause::get_map_name ( ) const

Get the name of the map variable constrained by this clause.

Returns
The Array object's name.

Definition at line 232 of file GSEClause.cc.

◆ get_start()

int functions::GSEClause::get_start ( ) const

Get the starting index of the clause's map variable as constrained by this clause.

Returns
The start index.

Definition at line 237 of file GSEClause.cc.

◆ get_stop()

int functions::GSEClause::get_stop ( ) const

Get the stopping index of the clause's map variable as constrained by this clause.

Returns
The stop index.

Definition at line 246 of file GSEClause.cc.

◆ OK()

bool functions::GSEClause::OK ( ) const

Class invariant.

Returns
True if the object is valid, otherwise False.

Definition at line 211 of file GSEClause.cc.

◆ set_map()

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

Set the pointer to the map vector contrained by this clause.

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

Returns
void

Definition at line 228 of file GSEClause.cc.

◆ set_start()

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

Set the starting index.

Returns
void

Definition at line 241 of file GSEClause.cc.

◆ set_stop()

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

Set the stopping index.

Returns
void

Definition at line 253 of file GSEClause.cc.


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