teca_rename_variables Class Reference
An algorithm that renames variables. More...
#include <teca_rename_variables.h>
Inheritance diagram for teca_rename_variables:
Collaboration diagram for teca_rename_variables:
Public Member Functions | |
| std::shared_ptr< teca_rename_variables > | shared_from_this () |
| std::shared_ptr< teca_rename_variables const > | shared_from_this () const |
| teca_rename_variables (const teca_rename_variables &src)=delete | |
| teca_rename_variables (teca_rename_variables &&src)=delete | |
| teca_rename_variables & | operator= (const teca_rename_variables &src)=delete |
| teca_rename_variables & | operator= (teca_rename_variables &&src)=delete |
| const char * | get_class_name () const override |
original_variable_names | |
Set the list of variables to rename. For each variable to rename a new name must be specified at the same index in the new_variable_names list. The two lists must be the same length. | |
| size_t | get_number_of_original_variable_names () |
| void | append_original_variable_name (const std::string &v) |
| void | set_original_variable_name (const std::string &v) |
| void | set_original_variable_name (size_t i, const std::string &v) |
| void | set_original_variable_names (const std::vector< std::string > &v) |
| void | set_original_variable_names (const std::initializer_list< std::string > &&l) |
| const std::string & | get_original_variable_name (size_t i) const |
| const std::vector< std::string > & | get_original_variable_names () const |
| void | clear_original_variable_names () |
new_variable_names | |
Set the names of the renamed variables. The new names are applied to the list of variables to rename in the same order and the two lists must be the same length. | |
| size_t | get_number_of_new_variable_names () |
| void | append_new_variable_name (const std::string &v) |
| void | set_new_variable_name (const std::string &v) |
| void | set_new_variable_name (size_t i, const std::string &v) |
| void | set_new_variable_names (const std::vector< std::string > &v) |
| void | set_new_variable_names (const std::initializer_list< std::string > &&l) |
| const std::string & | get_new_variable_name (size_t i) const |
| const std::vector< std::string > & | get_new_variable_names () const |
| void | clear_new_variable_names () |
 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 () |
| get the active communicator More... | |
| virtual teca_algorithm_output_port | get_output_port (unsigned int port=0) |
| void | set_input_connection (const teca_algorithm_output_port &port) |
| set an input to this algorithm More... | |
| virtual void | set_input_connection (unsigned int id, const teca_algorithm_output_port &port) |
| set an input to this algorithm More... | |
| virtual void | remove_input_connection (unsigned int id) |
| remove input connections More... | |
| void | clear_input_connections () |
| remove all input connections More... | |
| 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) |
| set the cache size. the default is 1. (threadsafe) More... | |
| virtual int | update () |
| execute the pipeline from this instance up. More... | |
| virtual int | update (unsigned int port) |
| execute the pipeline from this instance up. More... | |
| virtual teca_metadata | update_metadata (unsigned int port=0) |
| get meta data considering this instance up. More... | |
| void | set_executive (p_teca_algorithm_executive exe) |
| set the executive More... | |
| p_teca_algorithm_executive | get_executive () |
| get the executive More... | |
| virtual void | to_stream (std::ostream &s) const |
| virtual void | from_stream (std::istream &s) |
| deserialize from the stream. More... | |
| void | set_verbose (const int &v) |
| const int & | get_verbose () const |
Static Public Member Functions | |
| static p_teca_rename_variables | 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) |
| an overload to set_modified by port More... | |
| 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) |
| clear the cache on the given output port More... | |
| unsigned int | get_number_of_input_connections () |
| get the number of input connections More... | |
| teca_algorithm_output_port & | get_input_connection (unsigned int i) |
| void | clear_modified (unsigned int port) |
| clear the modified flag on the i'th output More... | |
| int | get_modified (unsigned int port) const |
| return the output port's modified flag value More... | |
| Protected Attributes inherited from teca_algorithm | |
| int | verbose |
Detailed Description
An algorithm that renames variables.
Member Function Documentation
◆ append_new_variable_name()
|
inline |
append to the new_variable_name algorithm vector property
◆ append_original_variable_name()
|
inline |
append to the original_variable_name algorithm vector property
◆ clear_new_variable_names()
|
inline |
clear the new_variable_name algorithm vector property
◆ clear_original_variable_names()
|
inline |
clear the original_variable_name algorithm vector property
◆ get_class_name()
|
inlineoverridevirtual |
returns the name of the class
Implements teca_algorithm.
◆ get_new_variable_name()
|
inline |
get the i-th element of the new_variable_name algorithm vector property
◆ get_new_variable_names()
|
inline |
get the new_variable_name algorithm vector property
◆ get_number_of_new_variable_names()
|
inline |
get the size of the new_variable_name algorithm vector property
◆ get_number_of_original_variable_names()
|
inline |
get the size of the original_variable_name algorithm vector property
◆ get_original_variable_name()
|
inline |
get the i-th element of the original_variable_name algorithm vector property
◆ get_original_variable_names()
|
inline |
get the original_variable_name algorithm vector property
◆ New()
|
inlinestatic |
Returns an instance of teca_rename_variables
◆ set_new_variable_name() [1/2]
|
inline |
set the new_variable_name algorithm vector property to a single value
◆ set_new_variable_name() [2/2]
|
inline |
set the i-th element of the new_variable_name algorithm vector property
◆ set_new_variable_names() [1/2]
|
inline |
set the new_variable_name algorithm vector property
◆ set_new_variable_names() [2/2]
|
inline |
set the new_variable_name algorithm vector property
◆ set_original_variable_name() [1/2]
|
inline |
set the original_variable_name algorithm vector property to a single value
◆ set_original_variable_name() [2/2]
|
inline |
set the i-th element of the original_variable_name algorithm vector property
◆ set_original_variable_names() [1/2]
|
inline |
set the original_variable_name algorithm vector property
◆ set_original_variable_names() [2/2]
|
inline |
set the original_variable_name algorithm vector property
◆ shared_from_this() [1/2]
|
inline |
Enables the static constructor
◆ shared_from_this() [2/2]
|
inline |
Enables the static constructor
The documentation for this class was generated from the following file:
- rtdfixjuly2025/alg/teca_rename_variables.h
