VAPoR  0.1
Public Member Functions | List of all members
VAPoR::PipeLine Class Referenceabstract

#include <DataMgr.h>

Public Member Functions

 PipeLine (string name, vector< string > inputs, vector< pair< string, DataMgr::VarType_T > > outputs)
 
virtual ~PipeLine ()
 
virtual int Calculate (vector< const RegularGrid * > input_grids, vector< RegularGrid * > output_grids, size_t ts, int reflevel, int lod)=0
 
const string & GetName () const
 Returns the PipeLine stages name. More...
 
const vector< string > & GetInputs () const
 Returns the PipeLine inputs. More...
 
const vector< pair< string, DataMgr::VarType_T > > & GetOutputs () const
 Returns the PipeLine outputs. More...
 

Detailed Description

The PipeLine abstract class declares pure virtual methods that may be defined to allow the construction of a data transformation pipeline.

Definition at line 1095 of file DataMgr.h.

Constructor & Destructor Documentation

VAPoR::PipeLine::PipeLine ( string  name,
vector< string >  inputs,
vector< pair< string, DataMgr::VarType_T > >  outputs 
)
inline

PipeLine stage constructor

Parameters
[in]namean identifier
[in]inputsA list of variable names required as inputs
[out]outputsA list of variable names and variable type pairs that will be output by the Calculate() method.

Definition at line 1105 of file DataMgr.h.

virtual VAPoR::PipeLine::~PipeLine ( )
inlinevirtual

Definition at line 1114 of file DataMgr.h.

Member Function Documentation

virtual int VAPoR::PipeLine::Calculate ( vector< const RegularGrid * >  input_grids,
vector< RegularGrid * >  output_grids,
size_t  ts,
int  reflevel,
int  lod 
)
pure virtual

Execute the pipeline stage

This pure virtual method is called from the DataMgr whenever a variable is requested whose name matches one of the output variable names. All output variables computed - including the requested one - will be stored in the cache for subsequent retrieval

const vector<string>& VAPoR::PipeLine::GetInputs ( ) const
inline

Returns the PipeLine inputs.

Definition at line 1139 of file DataMgr.h.

const string& VAPoR::PipeLine::GetName ( ) const
inline

Returns the PipeLine stages name.

Definition at line 1135 of file DataMgr.h.

const vector<pair <string, DataMgr::VarType_T> >& VAPoR::PipeLine::GetOutputs ( ) const
inline

Returns the PipeLine outputs.

Definition at line 1143 of file DataMgr.h.


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