An algorithm that evaluates an expression stores the result in a new variable. More...

#include <teca_evaluate_expression.h>

Inheritance diagram for teca_evaluate_expression:

Collaboration diagram for teca_evaluate_expression:

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

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

	teca_evaluate_expression (const teca_evaluate_expression &src)=delete

	teca_evaluate_expression (teca_evaluate_expression &&src)=delete

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

teca_evaluate_expression &	operator= (teca_evaluate_expression &&src)=delete

const char *	get_class_name () const override

expression
Set the expression to evaluate.
void	set_expression (const std::string &expr)

std::string	get_expression ()
	Get the expression. More...

result_variable
set the name of the variable to store the result in
void	set_result_variable (const std::string &v)

const std::string &	get_result_variable () const

result_attributes
set the NetCDF attributes of the result. This is needed for teca_cf_writer and is otherwise optional.
void	set_result_attributes (const teca_array_attributes &v)

const teca_array_attributes &	get_result_attributes () const

remove_dependent_variables
when set columns used in the calculation are removed from the output. default off.
void	set_remove_dependent_variables (const int &v)

const int &	get_remove_dependent_variables () const

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_evaluate_expression	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 &current)

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

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)
	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 evaluates an expression stores the result in a new variable.

The expression parser supports the following operations: +,-,*,/,%,<.<=,>,>=,==,!=,&&,||.!,?

Grouping in the expression is denoted in the usual way: ()

Constants in the expression are expanded to full length arrays and can be typed. The supported types are: d,f,L,l,i,s,c Corresponding to double,float, long long, long, int, short and char respectively. Integer types can be unsigned by including u after the code.

Member Function Documentation

◆ get_class_name()

const char* teca_evaluate_expression::get_class_name ( ) const

inlineoverridevirtual

returns the name of the class

Implements teca_algorithm.

◆ get_expression()

std::string teca_evaluate_expression::get_expression ( )

inline

Get the expression.

◆ get_remove_dependent_variables()

const int& teca_evaluate_expression::get_remove_dependent_variables ( ) const

inline

Get the value of the remove_dependent_variables algorithm property

◆ get_result_attributes()

const teca_array_attributes& teca_evaluate_expression::get_result_attributes ( ) const

inline

Get the value of the result_attributes algorithm property

◆ get_result_variable()

const std::string& teca_evaluate_expression::get_result_variable ( ) const

inline

Get the value of the result_variable algorithm property

◆ New()

static p_teca_evaluate_expression teca_evaluate_expression::New ( )

inlinestatic

Returns an instance of teca_evaluate_expression

◆ set_expression()

void teca_evaluate_expression::set_expression ( const std::string & expr )

Set the expression.

◆ set_remove_dependent_variables()

void teca_evaluate_expression::set_remove_dependent_variables ( const int & v )

inline

Set the value of the remove_dependent_variables algorithm property

◆ set_result_attributes()

void teca_evaluate_expression::set_result_attributes ( const teca_array_attributes & v )

inline

Set the value of the result_attributes algorithm property

◆ set_result_variable()

void teca_evaluate_expression::set_result_variable ( const std::string & v )

inline

Set the value of the result_variable algorithm property

◆ shared_from_this() [1/2]

std::shared_ptr< teca_evaluate_expression > teca_evaluate_expression::shared_from_this ( )

inline

Enables the static constructor

◆ shared_from_this() [2/2]

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

inline

Enables the static constructor

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

develop/alg/teca_evaluate_expression.h

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ get_class_name()

◆ get_expression()

◆ get_remove_dependent_variables()

◆ get_result_attributes()

◆ get_result_variable()

◆ New()

◆ set_expression()

◆ set_remove_dependent_variables()

◆ set_result_attributes()

◆ set_result_variable()

◆ shared_from_this() [1/2]

◆ shared_from_this() [2/2]