An algorithm that serves up user provided data and metadata. More...

#include <teca_dataset_source.h>

Inheritance diagram for teca_dataset_source:

Collaboration diagram for teca_dataset_source:

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

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

	teca_dataset_source (const teca_dataset_source &src)=delete

	teca_dataset_source (teca_dataset_source &&src)=delete

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

teca_dataset_source &	operator= (teca_dataset_source &&src)=delete

const char *	get_class_name () const override

size_t	get_number_of_datasets ()

void	append_dataset (const p_teca_dataset &v)

void	set_dataset (size_t i, const p_teca_dataset &v)

void	set_datasets (const std::vector< p_teca_dataset > &v)

void	set_datasets (const std::initializer_list< p_teca_dataset > &&l)

const p_teca_dataset &	get_dataset (size_t i) const

const std::vector< p_teca_dataset > &	get_datasets () const

void	clear_datasets ()

void	set_dataset (const p_teca_dataset &ds)

void	set_metadata (const teca_metadata &v)

const teca_metadata &	get_metadata () 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_dataset_source	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 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...

Protected Attributes inherited from teca_algorithm
int	verbose

Detailed Description

An algorithm that serves up user provided data and metadata.

This algorithm can be used to inject a dataset constructed on outside of TECA into a TECA pipeline.

Member Function Documentation

◆ append_dataset()

void teca_dataset_source::append_dataset ( const p_teca_dataset & v )

inline

append to the dataset algorithm vector property

◆ clear_datasets()

void teca_dataset_source::clear_datasets ( )

inline

clear the dataset algorithm vector property

◆ get_class_name()

const char* teca_dataset_source::get_class_name ( ) const

inlineoverridevirtual

returns the name of the class

Implements teca_algorithm.

◆ get_dataset()

const p_teca_dataset& teca_dataset_source::get_dataset ( size_t i ) const

inline

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

◆ get_datasets()

const std::vector< p_teca_dataset >& teca_dataset_source::get_datasets ( ) const

inline

get the dataset algorithm vector property

◆ get_metadata()

const teca_metadata& teca_dataset_source::get_metadata ( ) const

inline

Get the value of the metadata algorithm property

◆ get_number_of_datasets()

size_t teca_dataset_source::get_number_of_datasets ( )

inline

get the size of the dataset algorithm vector property

◆ New()

static p_teca_dataset_source teca_dataset_source::New ( )

inlinestatic

Returns an instance of teca_dataset_source

◆ set_dataset()

void teca_dataset_source::set_dataset	(	size_t	i,
		const p_teca_dataset &	v
	)

inline

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

◆ set_datasets() [1/2]

void teca_dataset_source::set_datasets ( const std::initializer_list< p_teca_dataset > && l )

inline

set the dataset algorithm vector property

◆ set_datasets() [2/2]

void teca_dataset_source::set_datasets ( const std::vector< p_teca_dataset > & v )

inline

set the dataset algorithm vector property

◆ set_metadata()

void teca_dataset_source::set_metadata ( const teca_metadata & v )

inline

Set the value of the metadata algorithm property

◆ shared_from_this() [1/2]

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

inline

Enables the static constructor

◆ shared_from_this() [2/2]

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

inline

Enables the static constructor

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

stable/core/teca_dataset_source.h

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ append_dataset()

◆ clear_datasets()

◆ get_class_name()

◆ get_dataset()

◆ get_datasets()

◆ get_metadata()

◆ get_number_of_datasets()

◆ New()

◆ set_dataset()

◆ set_datasets() [1/2]

◆ set_datasets() [2/2]

◆ set_metadata()

◆ shared_from_this() [1/2]

◆ shared_from_this() [2/2]