An executive that generates requests using a upstream or user defined index. More...

#include <teca_index_executive.h>

Inheritance diagram for teca_index_executive:

Collaboration diagram for teca_index_executive:

Public Member Functions
std::shared_ptr< teca_index_executive >	shared_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)
	set the index to process More...

void	set_start_index (long s)

void	set_end_index (long s)

void	set_stride (long s)
	Set the stride to process time steps at. The default is 1. More...

void	set_extent (unsigned long *ext)
	Set the extent to process. The default is taken from whole_extent key. More...

void	set_extent (const std::vector< unsigned long > &ext)
	Set the extent to process. The default is taken from whole_extent key. More...

void	set_bounds (double *bounds)

void	set_bounds (const std::vector< double > &bounds)

void	set_arrays (const std::vector< std::string > &arrays)
	Set the list of arrays to process. More...

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_executive &	operator= (const teca_algorithm_executive &)=default

teca_algorithm_executive &	operator= (teca_algorithm_executive &&)=default

Detailed Description

An executive that generates requests using a upstream or user defined index.

An extent or bounds to subset by, and list of arrays can be optionally set.

metadata 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 contain 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

Member Function Documentation

◆ New()

static p_teca_index_executive teca_index_executive::New ( )

inlinestatic

Allocate a new teca_index_executive

◆ set_arrays()

void teca_index_executive::set_arrays ( const std::vector< std::string > & arrays )

Set the list of arrays to process.

◆ set_bounds()

void teca_index_executive::set_bounds ( double * bounds )

Set the bounds to process. If nothing is set then extent as provided by set_extent is used.

◆ set_end_index()

void teca_index_executive::set_end_index ( long s )

Set the last time step in the series to process. default is -1. negative number results in the last available time step being used.

◆ set_extent() [1/2]

void teca_index_executive::set_extent ( const std::vector< unsigned long > & ext )

Set the extent to process. The default is taken from whole_extent key.

◆ set_extent() [2/2]

void teca_index_executive::set_extent ( unsigned long * ext )

Set the extent to process. The default is taken from whole_extent key.

◆ set_index()

void teca_index_executive::set_index ( long s )

set the index to process

◆ set_stride()

void teca_index_executive::set_stride ( long s )

Set the stride to process time steps at. The default is 1.

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

rtd_doxygen/core/teca_index_executive.h

Public Member Functions

Static Public Member Functions

Additional Inherited Members