an algorithm implemented with user provided callbacks More...

#include <teca_threaded_programmable_algorithm.h>

Inheritance diagram for teca_threaded_programmable_algorithm:

Public Member Functions
std::shared_ptr< teca_threaded_programmable_algorithm >	shared_from_this ()

std::shared_ptr< teca_threaded_programmable_algorithm const >	shared_from_this () const

	teca_threaded_programmable_algorithm (const teca_threaded_programmable_algorithm &src)=delete

	teca_threaded_programmable_algorithm (teca_threaded_programmable_algorithm &&src)=delete

teca_threaded_programmable_algorithm &	operator= (const teca_threaded_programmable_algorithm &src)=delete

teca_threaded_programmable_algorithm &	operator= (teca_threaded_programmable_algorithm &&src)=delete

virtual int	set_name (const std::string &name)

const char *	get_class_name () const override

void	use_default_report_action ()

void	use_default_request_action ()

void	use_default_execute_action ()

void	set_report_callback (const report_callback_t &v)

const report_callback_t &	get_report_callback () const

report_callback_t &	get_report_callback ()

void	set_request_callback (const request_callback_t &v)

const request_callback_t &	get_request_callback () const

request_callback_t &	get_request_callback ()

void	set_execute_callback (const threaded_execute_callback_t &v)

const threaded_execute_callback_t &	get_execute_callback () const

threaded_execute_callback_t &	get_execute_callback ()

void	set_number_of_input_connections (unsigned int n)

void	set_number_of_output_ports (unsigned int n)

void	set_thread_pool_size (int n_threads)

void	set_stream_size (const int &v)

Public Member Functions inherited from teca_threaded_algorithm
std::shared_ptr< teca_threaded_algorithm >	shared_from_this ()

std::shared_ptr< teca_threaded_algorithm const >	shared_from_this () const

	teca_threaded_algorithm (const teca_threaded_algorithm &src)=delete

	teca_threaded_algorithm (teca_threaded_algorithm &&src)=delete

teca_threaded_algorithm &	operator= (const teca_threaded_algorithm &src)=delete

teca_threaded_algorithm &	operator= (teca_threaded_algorithm &&src)=delete

void	set_thread_pool_size (int n_threads)

unsigned int	get_thread_pool_size () const noexcept

void	set_verbose (const int &v)

const int &	get_verbose () const

void	set_bind_threads (const int &v)

const int &	get_bind_threads () const

void	set_stream_size (const int &v)

const int &	get_stream_size () const

void	set_poll_interval (const long long &v)

const long long &	get_poll_interval () const

void	set_data_request_queue (const p_teca_data_request_queue &queue)

Public Member Functions inherited from teca_algorithm
	teca_algorithm (const teca_algorithm &src)=delete

	teca_algorithm (teca_algorithm &&src)=delete

teca_algorithm &	operator= (const teca_algorithm &src)=delete

teca_algorithm &	operator= (teca_algorithm &&src)=delete

void	set_communicator (MPI_Comm comm)

MPI_Comm	get_communicator ()

virtual teca_algorithm_output_port	get_output_port (unsigned int port=0)

void	set_input_connection (const teca_algorithm_output_port &port)

virtual void	set_input_connection (unsigned int id, const teca_algorithm_output_port &port)

virtual void	remove_input_connection (unsigned int id)

void	clear_input_connections ()

const_p_teca_dataset	get_output_data (unsigned int port=0)

void	pop_cache (unsigned int port=0, int top=0)

void	set_cache_size (unsigned int n)

virtual int	update ()

virtual int	update (unsigned int port)

virtual teca_metadata	update_metadata (unsigned int port=0)

void	set_executive (p_teca_algorithm_executive exe)

p_teca_algorithm_executive	get_executive ()

virtual void	to_stream (std::ostream &s) const

virtual void	from_stream (std::istream &s)

Static Public Member Functions
static p_teca_threaded_programmable_algorithm	New ()

Static Public Member Functions inherited from teca_threaded_algorithm
static p_teca_threaded_algorithm	New ()

Protected Attributes
report_callback_t	report_callback

request_callback_t	request_callback

threaded_execute_callback_t	execute_callback

char	class_name [64]

Additional Inherited Members
Protected Member Functions inherited from teca_threaded_algorithm
const_p_teca_dataset	execute (unsigned int port, const std::vector< const_p_teca_dataset > &input_data, const teca_metadata &request) override

const_p_teca_dataset	request_data (teca_algorithm_output_port &port, const teca_metadata &request) override

Protected Member Functions inherited from teca_algorithm
void	set_number_of_input_connections (unsigned int n)

void	set_number_of_output_ports (unsigned int n)

virtual void	set_modified ()

void	set_modified (unsigned int port)

virtual teca_metadata	get_cache_key (unsigned int port, const teca_metadata &request) const

virtual teca_metadata	get_output_metadata (teca_algorithm_output_port &current)

virtual int	validate_cache (teca_algorithm_output_port &current)

virtual void	clear_modified (teca_algorithm_output_port current)

const_p_teca_dataset	get_output_data (unsigned int port, const teca_metadata &request)

int	cache_output_data (unsigned int port, const teca_metadata &request, const_p_teca_dataset &data)

void	clear_cache (unsigned int port)

unsigned int	get_number_of_input_connections ()

teca_algorithm_output_port &	get_input_connection (unsigned int i)

void	clear_modified (unsigned int port)

int	get_modified (unsigned int port) const

Detailed Description

an algorithm implemented with user provided callbacks

This version of the teca_programmable_algorithm is threaded. A thread pool (call set_thread_pool_size to initialize) executes the upstream pipeline asynchronously for each request made. Hence, this version of the prpogrammable algorithm is most useful when there are multiple requests to be processed. Data from the set of requests can be processed incrementally when streaming (see set_stream_size to initialize). If one doesn't need these features it is better to use the teca_programmable_algorithm instead. See teca_threaded_algorithm for more details about threaded execution.

The user can provide a callback for each of the three phases of pipeline execution. The number of input and output ports can also be set for filters (1 or more inputs, 1 or more outputs) sources, (no inputs, 1 or more outputs), or sinks (1 or more inputs, no outputs).

1) report phase. the report callback returns metadata describing data that can be produced. The report callback is optional. It's only needed if the algorithm will produce new data or transform metadata.

the report callback must be callable with signature: teca_metadata(unsigned int)

2) request phase. the request callback generates a vector of requests(metadata objects) that inform the upstream of what data to generate. The request callback is optional. It's only needed if the algorithm needs data from the upstream or transform metadata.

the request callback must be callable with the signature: std::vector<teca_metadata>( unsigned int, const std::vector<teca_metadata> &, const teca_metadata &)

3) execute phase. the execute callback is used to do useful work on incoming or outgoing data. Examples include generating new datasets, processing datasets, reading and writing data to/from disk, and so on. The execute callback is optional.

the execute callback must be callable with the signature: const_p_teca_dataset( unsigned int, const std::vector<const_p_teca_dataset> &, const teca_metadata &, int)

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description