TECA
Public Types | Public Member Functions | Static Public Member Functions | List of all members
teca_table_writer Class Reference

teca_table_writer - writes tabular datasets in CSV format. More...

#include <teca_table_writer.h>

Inheritance diagram for teca_table_writer:
teca_algorithm

Public Types

enum  {
  format_auto, format_csv, format_bin, format_xlsx,
  format_netcdf
}
 

Public Member Functions

std::shared_ptr< teca_table_writershared_from_this ()
 
std::shared_ptr< teca_table_writer const > shared_from_this () const
 
 teca_table_writer (const teca_table_writer &src)=delete
 
 teca_table_writer (teca_table_writer &&src)=delete
 
teca_table_writeroperator= (const teca_table_writer &src)=delete
 
teca_table_writeroperator= (teca_table_writer &&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_row_dim_name (const std::string &v)
 
const std::string & get_row_dim_name () const
 
void set_output_format (const int &v)
 
const int & get_output_format () const
 
void set_output_format_auto ()
 
void set_output_format_csv ()
 
void set_output_format_bin ()
 
void set_output_format_xlsx ()
 
void set_output_format_netcdf ()
 
- 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_table_writer 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)
 
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

teca_table_writer - writes tabular datasets in CSV format.

an algorithm that writes tabular data in a binary or CSV (comma separated value) format that is easily ingested by most spreadsheet apps. Each page of a database is written to a file.

The binary format is internal to TECA, and provides the best performance.

The CSV format is intended for use getting data into other tools such as MS Excel and or Python based codes.

See TECA CSV format specification in teca_table_reader for more information.


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