An algorithm that transforms NetCDF CF-2 time variable into an absolute date. More...

#include <teca_table_calendar.h>

Inheritance diagram for teca_table_calendar:

Collaboration diagram for teca_table_calendar:

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

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

	teca_table_calendar (const teca_table_calendar &src)=delete

	teca_table_calendar (teca_table_calendar &&src)=delete

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

teca_table_calendar &	operator= (teca_table_calendar &&src)=delete

const char *	get_class_name () const override

void	set_time_column (const std::string &v)

const std::string &	get_time_column () const

void	set_units (const std::string &v)

const std::string &	get_units () const

void	set_calendar (const std::string &v)

const std::string &	get_calendar () const

void	set_year_column (const std::string &v)

const std::string &	get_year_column () const

void	set_month_column (const std::string &v)

const std::string &	get_month_column () const

void	set_day_column (const std::string &v)

const std::string &	get_day_column () const

void	set_hour_column (const std::string &v)

const std::string &	get_hour_column () const

void	set_minute_column (const std::string &v)

const std::string &	get_minute_column () const

void	set_second_column (const std::string &v)

const std::string &	get_second_column () const

void	set_output_column_prefix (const std::string &v)

const std::string &	get_output_column_prefix () 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_table_calendar	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 teca_metadata	get_output_metadata (unsigned int port, const std::vector< teca_metadata > &input_md)

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 transforms NetCDF CF-2 time variable into an absolute date.

Transform NetCDF CF-2 time variable into an absolute date. By default the "time" column is used, but this can be over road by set_active_column methods. the table must have temporal metadata containing base date and calendar units following the CF-2 convention. the output table will contain year,month,day,hours, minutes columns.

Note: This should be used in serial, as the UDUNITS package loads an XML file in each instance. The CalCalcs package also has thread safety issues.

Member Function Documentation

◆ get_calendar()

const std::string& teca_table_calendar::get_calendar ( ) const

inline

Get the value of the calendar algorithm property

◆ get_class_name()

const char* teca_table_calendar::get_class_name ( ) const

inlineoverridevirtual

returns the name of the class

Implements teca_algorithm.

◆ get_day_column()

const std::string& teca_table_calendar::get_day_column ( ) const

inline

Get the value of the day_column algorithm property

◆ get_hour_column()

const std::string& teca_table_calendar::get_hour_column ( ) const

inline

Get the value of the hour_column algorithm property

◆ get_minute_column()

const std::string& teca_table_calendar::get_minute_column ( ) const

inline

Get the value of the minute_column algorithm property

◆ get_month_column()

const std::string& teca_table_calendar::get_month_column ( ) const

inline

Get the value of the month_column algorithm property

◆ get_output_column_prefix()

const std::string& teca_table_calendar::get_output_column_prefix ( ) const

inline

Get the value of the output_column_prefix algorithm property

◆ get_second_column()

const std::string& teca_table_calendar::get_second_column ( ) const

inline

Get the value of the second_column algorithm property

◆ get_time_column()

const std::string& teca_table_calendar::get_time_column ( ) const

inline

Get the value of the time_column algorithm property

◆ get_units()

const std::string& teca_table_calendar::get_units ( ) const

inline

Get the value of the units algorithm property

◆ get_year_column()

const std::string& teca_table_calendar::get_year_column ( ) const

inline

Get the value of the year_column algorithm property

◆ New()

static p_teca_table_calendar teca_table_calendar::New ( )

inlinestatic

Returns an instance of teca_table_calendar

◆ set_calendar()

void teca_table_calendar::set_calendar ( const std::string & v )

inline

Set the value of the calendar algorithm property

◆ set_day_column()

void teca_table_calendar::set_day_column ( const std::string & v )

inline

Set the value of the day_column algorithm property

◆ set_hour_column()

void teca_table_calendar::set_hour_column ( const std::string & v )

inline

Set the value of the hour_column algorithm property

◆ set_minute_column()

void teca_table_calendar::set_minute_column ( const std::string & v )

inline

Set the value of the minute_column algorithm property

◆ set_month_column()

void teca_table_calendar::set_month_column ( const std::string & v )

inline

Set the value of the month_column algorithm property

◆ set_output_column_prefix()

void teca_table_calendar::set_output_column_prefix ( const std::string & v )

inline

Set the value of the output_column_prefix algorithm property

◆ set_second_column()

void teca_table_calendar::set_second_column ( const std::string & v )

inline

Set the value of the second_column algorithm property

◆ set_time_column()

void teca_table_calendar::set_time_column ( const std::string & v )

inline

Set the value of the time_column algorithm property

◆ set_units()

void teca_table_calendar::set_units ( const std::string & v )

inline

Set the value of the units algorithm property

◆ set_year_column()

void teca_table_calendar::set_year_column ( const std::string & v )

inline

Set the value of the year_column algorithm property

◆ shared_from_this() [1/2]

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

inline

Enables the static constructor

◆ shared_from_this() [2/2]

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

inline

Enables the static constructor

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

develop/alg/teca_table_calendar.h

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ get_calendar()

◆ get_class_name()

◆ get_day_column()

◆ get_hour_column()

◆ get_minute_column()

◆ get_month_column()

◆ get_output_column_prefix()

◆ get_second_column()

◆ get_time_column()

◆ get_units()

◆ get_year_column()

◆ New()

◆ set_calendar()

◆ set_day_column()

◆ set_hour_column()

◆ set_minute_column()

◆ set_month_column()

◆ set_output_column_prefix()

◆ set_second_column()

◆ set_time_column()

◆ set_units()

◆ set_year_column()

◆ shared_from_this() [1/2]

◆ shared_from_this() [2/2]