An algorithm to read time axis and its attributes in parallel. More...

#include <teca_cf_time_axis_reader.h>

Inheritance diagram for teca_cf_time_axis_reader:

Collaboration diagram for teca_cf_time_axis_reader:

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

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

	teca_cf_time_axis_reader (const teca_cf_time_axis_reader &src)=delete

	teca_cf_time_axis_reader (teca_cf_time_axis_reader &&src)=delete

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

teca_cf_time_axis_reader &	operator= (teca_cf_time_axis_reader &&src)=delete

const char *	get_class_name () const override

void	set_files_regex (const std::string &v)

const std::string &	get_files_regex () const

size_t	get_number_of_file_names ()

void	append_file_name (const std::string &v)

void	set_file_name (size_t i, const std::string &v)

void	set_file_names (const std::vector< std::string > &v)

void	set_file_names (const std::initializer_list< std::string > &&l)

const std::string &	get_file_name (size_t i) const

const std::vector< std::string > &	get_file_names () const

void	clear_file_names ()

void	set_t_axis_variable (const std::string &v)

const std::string &	get_t_axis_variable () const

const std::string &	get_path () const

const std::vector< std::string > &	get_files () 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_cf_time_axis_reader	New ()

Protected Member Functions
void	set_modified () override

teca_metadata	get_output_metadata (unsigned int port, const std::vector< teca_metadata > &input_md) override

const_p_teca_dataset	execute (unsigned int port, const std::vector< const_p_teca_dataset > &input_data, const teca_metadata &request) override

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 &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...

Additional Inherited Members
Protected Attributes inherited from teca_algorithm
int	verbose

Detailed Description

An algorithm to read time axis and its attributes in parallel.

Member Function Documentation

◆ append_file_name()

void teca_cf_time_axis_reader::append_file_name ( const std::string & v )

inline

append to the file_name algorithm vector property

◆ clear_file_names()

void teca_cf_time_axis_reader::clear_file_names ( )

inline

clear the file_name algorithm vector property

◆ execute()

const_p_teca_dataset teca_cf_time_axis_reader::execute	(	unsigned int	port,
		const std::vector< const_p_teca_dataset > &	input_data,
		const teca_metadata &	request
	)

overrideprotectedvirtual

implementations must override this method and produce the output dataset for the port named in the first argument. The second argument is a list of all of the input datasets. See also get_request. The third argument contains a request from the consumer which can specify information such as arrays, subset region, timestep etc. The implementation is free to handle the request as it sees fit.

Reimplemented from teca_algorithm.

◆ get_class_name()

const char* teca_cf_time_axis_reader::get_class_name ( ) const

inlineoverridevirtual

returns the name of the class

Implements teca_algorithm.

◆ get_file_name()

const std::string& teca_cf_time_axis_reader::get_file_name ( size_t i ) const

inline

get the i-th element of the file_name algorithm vector property

◆ get_file_names()

const std::vector< std::string >& teca_cf_time_axis_reader::get_file_names ( ) const

inline

get the file_name algorithm vector property

◆ get_files_regex()

const std::string& teca_cf_time_axis_reader::get_files_regex ( ) const

inline

Get the value of the files_regex algorithm property

◆ get_number_of_file_names()

size_t teca_cf_time_axis_reader::get_number_of_file_names ( )

inline

get the size of the file_name algorithm vector property

◆ get_output_metadata()

teca_metadata teca_cf_time_axis_reader::get_output_metadata	(	unsigned int	port,
		const std::vector< teca_metadata > &	input_md
	)

overrideprotectedvirtual

implementations must override this method to provide information to downstream consumers about what data will be produced on each output port. The port to provide information about is named in the first argument the second argument contains a list of the metadata describing data on all of the inputs.

Reimplemented from teca_algorithm.

◆ get_t_axis_variable()

const std::string& teca_cf_time_axis_reader::get_t_axis_variable ( ) const

inline

Get the value of the t_axis_variable algorithm property

◆ New()

static p_teca_cf_time_axis_reader teca_cf_time_axis_reader::New ( )

inlinestatic

Returns an instance of teca_cf_time_axis_reader

◆ set_file_name()

void teca_cf_time_axis_reader::set_file_name	(	size_t	i,
		const std::string &	v
	)

inline

set the i-th element of the file_name algorithm vector property

◆ set_file_names() [1/2]

void teca_cf_time_axis_reader::set_file_names ( const std::initializer_list< std::string > && l )

inline

set the file_name algorithm vector property

◆ set_file_names() [2/2]

void teca_cf_time_axis_reader::set_file_names ( const std::vector< std::string > & v )

inline

set the file_name algorithm vector property

◆ set_files_regex()

void teca_cf_time_axis_reader::set_files_regex ( const std::string & v )

inline

Set the value of the files_regex algorithm property

◆ set_modified()

void teca_cf_time_axis_reader::set_modified ( )

overrideprotectedvirtual

set the modified flag on the given output port's cache. should be called when user modifies properties on the object that require the output to be regenerated.

Reimplemented from teca_algorithm.

◆ set_t_axis_variable()

void teca_cf_time_axis_reader::set_t_axis_variable ( const std::string & v )

inline

Set the value of the t_axis_variable algorithm property

◆ shared_from_this() [1/2]

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

inline

Enables the static constructor

◆ shared_from_this() [2/2]

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

inline

Enables the static constructor

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

rtd_doxygen/io/teca_cf_time_axis_reader.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ append_file_name()

◆ clear_file_names()

◆ execute()

◆ get_class_name()

◆ get_file_name()

◆ get_file_names()

◆ get_files_regex()

◆ get_number_of_file_names()

◆ get_output_metadata()

◆ get_t_axis_variable()

◆ New()

◆ set_file_name()

◆ set_file_names() [1/2]

◆ set_file_names() [2/2]

◆ set_files_regex()

◆ set_modified()

◆ set_t_axis_variable()

◆ shared_from_this() [1/2]

◆ shared_from_this() [2/2]