a programmable algorithm specialized for simple array based computations More...
#include <teca_derived_quantity.h>
Inheritance diagram for teca_derived_quantity:
Public Member Functions | |
| std::shared_ptr< teca_derived_quantity > | shared_from_this () |
| std::shared_ptr< teca_derived_quantity const > | shared_from_this () const |
| teca_derived_quantity (const teca_derived_quantity &src)=delete | |
| teca_derived_quantity (teca_derived_quantity &&src)=delete | |
| teca_derived_quantity & | operator= (const teca_derived_quantity &src)=delete |
| teca_derived_quantity & | operator= (teca_derived_quantity &&src)=delete |
| size_t | get_number_of_dependent_variables () |
| void | append_dependent_variable (const std::string &v) |
| void | set_dependent_variable (size_t i, const std::string &v) |
| void | set_dependent_variables (const std::vector< std::string > &v) |
| void | set_dependent_variables (const std::initializer_list< std::string > &&l) |
| void | set_dependent_variables (const const_p_teca_variant_array &v) |
| const std::string & | get_dependent_variable (size_t i) const |
| void | get_dependent_variables (std::vector< std::string > &v) const |
| void | get_dependent_variables (const p_teca_variant_array &v) const |
| void | clear_dependent_variables () |
| void | set_derived_variable (const std::string &v) |
| const std::string & | get_derived_variable () const |
| void | set_operation_name (const std::string &v) |
| const std::string & | get_operation_name () const |
| std::string & | get_operation_name () |
| void | set_execute_callback (const execute_callback_t &v) |
| const execute_callback_t & | get_execute_callback () const |
| execute_callback_t & | get_execute_callback () |
 Public Member Functions inherited from teca_programmable_algorithm | |
| std::shared_ptr< teca_programmable_algorithm > | shared_from_this () |
| std::shared_ptr< teca_programmable_algorithm const > | shared_from_this () const |
| teca_programmable_algorithm (const teca_programmable_algorithm &src)=delete | |
| teca_programmable_algorithm (teca_programmable_algorithm &&src)=delete | |
| teca_programmable_algorithm & | operator= (const teca_programmable_algorithm &src)=delete |
| teca_programmable_algorithm & | operator= (teca_programmable_algorithm &&src)=delete |
| 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 execute_callback_t &v) |
| const execute_callback_t & | get_execute_callback () const |
| execute_callback_t & | get_execute_callback () |
| void | set_number_of_input_connections (unsigned int n) |
| void | set_number_of_output_ports (unsigned int n) |
| 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_derived_quantity | New () |
| Static Public Member Functions inherited from teca_programmable_algorithm | |
| static p_teca_programmable_algorithm | New () |
Additional Inherited Members | |
| 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 ¤t) |
| virtual const_p_teca_dataset | request_data (teca_algorithm_output_port &port, const teca_metadata &request) |
| virtual int | validate_cache (teca_algorithm_output_port ¤t) |
| 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 |
| Protected Attributes inherited from teca_programmable_algorithm | |
| report_callback_t | report_callback |
| request_callback_t | request_callback |
| execute_callback_t | execute_callback |
| char | class_name [64] |
Detailed Description
a programmable algorithm specialized for simple array based computations
A programmable algorithm specialized for simple array based computations. A user provided callable(see set execute_callback) which operates on one or more arrays(the dependent variables) to produce a new array (the derived quantity). The purpose of this class is to implement the request and report phases of the pipeline consistently for this common use case. An implementation specific context(operation_name) differentiates between multiple instances in the same pipeline.
The documentation for this class was generated from the following files:
- TECA/alg/teca_derived_quantity.h
- TECA/alg/teca_derived_quantity.cxx
