TECA
The Toolkit for Extreme Climate Analysis
teca_table_remove_rows Class Reference

An algorithm that removes rows from a table where a given expression evaluates to true. More...

#include <teca_table_remove_rows.h>

Inheritance diagram for teca_table_remove_rows:
[legend]
Collaboration diagram for teca_table_remove_rows:
[legend]

Public Member Functions

std::shared_ptr< teca_table_remove_rowsshared_from_this ()
 
std::shared_ptr< teca_table_remove_rows const > shared_from_this () const
 
 teca_table_remove_rows (const teca_table_remove_rows &src)=delete
 
 teca_table_remove_rows (teca_table_remove_rows &&src)=delete
 
teca_table_remove_rowsoperator= (const teca_table_remove_rows &src)=delete
 
teca_table_remove_rowsoperator= (teca_table_remove_rows &&src)=delete
 
const char * get_class_name () const override
 
mask_expression

set the expression to use to determine which rows are removed. rows are removed where the expression evaluates true.

void set_mask_expression (const std::string &expr)
 
std::string get_mask_expression ()
 Get the mask expression. More...
 
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_algorithmoperator= (const teca_algorithm &src)=delete
 
teca_algorithmoperator= (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_table_remove_rows 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_output_metadata (unsigned int port, const std::vector< teca_metadata > &input_md)
 
virtual std::vector< teca_metadataget_upstream_request (unsigned int port, const std::vector< teca_metadata > &input_md, const teca_metadata &request)
 
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_portget_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 removes rows from a table where a given expression evaluates to true.

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_table_remove_rows::get_class_name ( ) const
inlineoverridevirtual

returns the name of the class

Implements teca_algorithm.

◆ get_mask_expression()

std::string teca_table_remove_rows::get_mask_expression ( )
inline

Get the mask expression.

◆ get_remove_dependent_variables()

const int& teca_table_remove_rows::get_remove_dependent_variables ( ) const
inline

Get the value of the remove_dependent_variables algorithm property

◆ New()

static p_teca_table_remove_rows teca_table_remove_rows::New ( )
inlinestatic

Returns an instance of teca_table_remove_rows

◆ set_mask_expression()

void teca_table_remove_rows::set_mask_expression ( const std::string &  expr)

Set the mask expression

◆ set_remove_dependent_variables()

void teca_table_remove_rows::set_remove_dependent_variables ( const int &  v)
inline

Set the value of the remove_dependent_variables algorithm property

◆ shared_from_this() [1/2]

std::shared_ptr< teca_table_remove_rows > teca_table_remove_rows::shared_from_this ( )
inline

Enables the static constructor

◆ shared_from_this() [2/2]

std::shared_ptr< teca_table_remove_rows const> teca_table_remove_rows::shared_from_this ( ) const
inline

Enables the static constructor


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