A reader for data stored in binary cartesian_mesh format. More...
#include <teca_cartesian_mesh_reader.h>
Public Member Functions | |
| std::shared_ptr< teca_cartesian_mesh_reader > | shared_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_reader & | operator= (const teca_cartesian_mesh_reader &src)=delete |
| teca_cartesian_mesh_reader & | operator= (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) |
| const std::string & | get_metadata_column_name (size_t i) const |
| const std::vector< std::string > & | get_metadata_column_names () 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) |
| const std::string & | get_metadata_column_key (size_t i) const |
| const std::vector< std::string > & | get_metadata_column_keys () 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_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_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) |
| an overload to set_modified by port More... | |
| virtual std::vector< teca_metadata > | get_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 ¤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
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.
Member Function Documentation
◆ append_metadata_column_key()
|
inline |
append to the metadata_column_key algorithm vector property
◆ append_metadata_column_name()
|
inline |
append to the metadata_column_name algorithm vector property
◆ clear_metadata_column_keys()
|
inline |
clear the metadata_column_key algorithm vector property
◆ clear_metadata_column_names()
|
inline |
clear the metadata_column_name algorithm vector property
◆ get_class_name()
|
inlineoverridevirtual |
returns the name of the class
Implements teca_algorithm.
◆ get_file_name()
|
inline |
Get the value of the file_name algorithm property
◆ get_generate_original_ids()
|
inline |
Get the value of the generate_original_ids algorithm property
◆ get_index_column()
|
inline |
Get the value of the index_column algorithm property
◆ get_metadata_column_key()
|
inline |
get the i-th element of the metadata_column_key algorithm vector property
◆ get_metadata_column_keys()
|
inline |
get the metadata_column_key algorithm vector property
◆ get_metadata_column_name()
|
inline |
get the i-th element of the metadata_column_name algorithm vector property
◆ get_metadata_column_names()
|
inline |
get the metadata_column_name algorithm vector property
◆ get_number_of_metadata_column_keys()
|
inline |
get the size of the metadata_column_key algorithm vector property
◆ get_number_of_metadata_column_names()
|
inline |
get the size of the metadata_column_name algorithm vector property
◆ New()
|
inlinestatic |
Returns an instance of teca_cartesian_mesh_reader
◆ set_file_name()
|
inline |
Set the value of the file_name algorithm property
◆ set_generate_original_ids()
|
inline |
Set the value of the generate_original_ids algorithm property
◆ set_index_column()
|
inline |
Set the value of the index_column algorithm property
◆ set_metadata_column_key()
|
inline |
set the i-th element of the metadata_column_key algorithm vector property
◆ set_metadata_column_keys() [1/2]
|
inline |
set the metadata_column_key algorithm vector property
◆ set_metadata_column_keys() [2/2]
|
inline |
set the metadata_column_key algorithm vector property
◆ set_metadata_column_name()
|
inline |
set the i-th element of the metadata_column_name algorithm vector property
◆ set_metadata_column_names() [1/2]
|
inline |
set the metadata_column_name algorithm vector property
◆ set_metadata_column_names() [2/2]
|
inline |
set the metadata_column_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:
- stable/io/teca_cartesian_mesh_reader.h
