TECA
Public Member Functions | Static Public Member Functions | List of all members
teca_index_executive Class Reference

#include <teca_index_executive.h>

Inheritance diagram for teca_index_executive:
teca_algorithm_executive

Public Member Functions

std::shared_ptr< teca_index_executiveshared_from_this ()
 
std::shared_ptr< teca_index_executive const > shared_from_this () const
 
int initialize (MPI_Comm comm, const teca_metadata &md) override
 
teca_metadata get_next_request () override
 
void set_index (long s)
 
void set_start_index (long s)
 
void set_end_index (long s)
 
void set_stride (long s)
 
void set_extent (unsigned long *ext)
 
void set_extent (const std::vector< unsigned long > &ext)
 
void set_bounds (double *bounds)
 
void set_bounds (const std::vector< double > &bounds)
 
void set_arrays (const std::vector< std::string > &arrays)
 
- Public Member Functions inherited from teca_algorithm_executive
void set_verbose (int a_verbose)
 
int get_verbose () const
 

Static Public Member Functions

static p_teca_index_executive New ()
 
- Static Public Member Functions inherited from teca_algorithm_executive
static p_teca_algorithm_executive New ()
 

Additional Inherited Members

- Protected Member Functions inherited from teca_algorithm_executive
 teca_algorithm_executive (const teca_algorithm_executive &)=default
 
 teca_algorithm_executive (teca_algorithm_executive &&)=default
 
teca_algorithm_executiveoperator= (const teca_algorithm_executive &)=default
 
teca_algorithm_executiveoperator= (teca_algorithm_executive &&)=default
 

Detailed Description

An executive that generates requests using a upstream or user defined index. an extent and list of arrays can be optionally set.

meta data keys:

 requires:

 index_initializer_key -- holds the name of the key that tells how
                          many indices are available. the named key
                          must also be present and should conatin the
                          number of indices available

 index_request_key -- holds the name of the key used to request
                      a specific index. request are generated with this
                      name set to a specific index to be processed some
                      upstream algorithm is expected to produce the data
                      associated with the given index

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