TECA
Classes | Public Member Functions | Static Public Member Functions | List of all members
teca_cartesian_mesh_reader Class Reference

a reader for data stored in binary cartesian_mesh format More...

#include <teca_cartesian_mesh_reader.h>

Inheritance diagram for teca_cartesian_mesh_reader:
teca_algorithm

Classes

struct  teca_cartesian_mesh_reader_internals
 

Public Member Functions

std::shared_ptr< teca_cartesian_mesh_readershared_from_this ()
 
std::shared_ptr< teca_cartesian_mesh_reader const > shared_from_this () const
 
 teca_cartesian_mesh_reader (const teca_cartesian_mesh_reader &src)=delete
 
 teca_cartesian_mesh_reader (teca_cartesian_mesh_reader &&src)=delete
 
teca_cartesian_mesh_readeroperator= (const teca_cartesian_mesh_reader &src)=delete
 
teca_cartesian_mesh_readeroperator= (teca_cartesian_mesh_reader &&src)=delete
 
const char * get_class_name () const override
 
void set_file_name (const std::string &v)
 
const std::string & get_file_name () const
 
void set_index_column (const std::string &v)
 
const std::string & get_index_column () const
 
void set_generate_original_ids (const int &v)
 
const int & get_generate_original_ids () const
 
size_t get_number_of_metadata_column_names ()
 
void append_metadata_column_name (const std::string &v)
 
void set_metadata_column_name (size_t i, const std::string &v)
 
void set_metadata_column_names (const std::vector< std::string > &v)
 
void set_metadata_column_names (const std::initializer_list< std::string > &&l)
 
void set_metadata_column_names (const const_p_teca_variant_array &v)
 
const std::string & get_metadata_column_name (size_t i) const
 
void get_metadata_column_names (std::vector< std::string > &v) const
 
void get_metadata_column_names (const p_teca_variant_array &v) const
 
void clear_metadata_column_names ()
 
size_t get_number_of_metadata_column_keys ()
 
void append_metadata_column_key (const std::string &v)
 
void set_metadata_column_key (size_t i, const std::string &v)
 
void set_metadata_column_keys (const std::vector< std::string > &v)
 
void set_metadata_column_keys (const std::initializer_list< std::string > &&l)
 
void set_metadata_column_keys (const const_p_teca_variant_array &v)
 
const std::string & get_metadata_column_key (size_t i) const
 
void get_metadata_column_keys (std::vector< std::string > &v) const
 
void get_metadata_column_keys (const p_teca_variant_array &v) const
 
void clear_metadata_column_keys ()
 
void add_metadata_column (const std::string &column, const std::string &key)
 
void clear_metadata_columns ()
 
- 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 ()
 
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_cartesian_mesh_reader 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)
 
void set_modified (unsigned int port)
 
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)
 
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

a reader for data stored in binary cartesian_mesh format

A reader for data stored in binary cartesian_mesh format. By default the reader reads and returns the entire cartesian_mesh on rank 0. The reader can partition the data accross an "index column". The index column assigns a unique id to rows that should be returned together. The reader reports the number of unique ids to the pipeline which can then be requested by the pipeline during parallel or sequential execution.

output: generates a cartesian_mesh containing the data read from the file.


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