tom::tsdb::collections::sparse_series< T, NATIVE_TYPE > Class Template Reference

Inheritance diagram for tom::tsdb::collections::sparse_series< T, NATIVE_TYPE >:

Collaboration diagram for tom::tsdb::collections::sparse_series< T, NATIVE_TYPE >:

Public Types
typedef T::value_type	value_type
Public Types inherited from tom::tsdb::time_series
typedef std::map< tom::string, tom::string >	attribute_map_t
typedef std::set< tom::string >	attribute_set_t
typedef bool(tom::tsdb::datastore::*	populate_data_func) (tom::collections::time_series &ts, const tom::string &name, tom::tsdb::native_data_type data_t, tom::calendars::calendar &cal, tom::calendars::date_int_type from, tom::calendars::date_int_type to)

Public Member Functions
template<typename IteratorT >
	sparse_series (tom::calendars::calendar &cal, datastore &ds, const observation &name, aggregation_type agg_t, const tom::calendars::date_time &created, const tom::calendars::date_time &modified, IteratorT begin, IteratorT end)
	sparse_series (tom::calendars::calendar &cal, datastore &ds, const observation &name, aggregation_type)
	sparse_series (tom::calendars::calendar &cal, datastore &ds, const observation &name, aggregation_type, const tom::calendars::date_time &created, const tom::calendars::date_time &modified)
virtual tom::collections::time_series_iterator &	begin () const
virtual tom::collections::time_series_iterator &	end () const
virtual aggregation_type	get_aggregation_type () const
virtual tom::calendars::calendar &	get_calendar () const
virtual const tom::calendars::date_time &	get_create_date_time () const
virtual const values::data_type &	get_data_type () const
virtual datastore &	get_datastore () const
virtual bool	get_fill_forward () const
virtual tom::calendars::date_int_type	get_first_date_int () const
virtual tom::calendars::date_int_type	get_first_dirty_date_int () const
virtual bool	get_ignore_missing_values () const
virtual bool	get_ignore_same_values () const
virtual tom::calendars::date_int_type	get_last_date_int () const
virtual tom::calendars::date_int_type	get_last_dirty_date_int () const
virtual const tom::calendars::date_time &	get_modify_date_time () const
virtual const tom::string &	get_name () const
virtual const tom::observation &	get_observation (const tom::calendars::date d) const
virtual const tom::observation &	get_observation (const tom::calendars::date_int_type d) const
virtual const void *	get_raw_data () const
virtual bool	is_sparse_series () const
virtual tom::observation &	operator[] (const tom::calendars::date d)
virtual const tom::observation &	operator[] (const tom::calendars::date d) const
virtual tom::observation &	operator[] (const tom::calendars::date_int_type d)
virtual const tom::observation &	operator[] (const tom::calendars::date_int_type d) const
virtual std::ostream &	print (std::ostream &) const
virtual void	set_aggregation_type (aggregation_type)
virtual void	set_fill_forward (bool b)
virtual void	set_ignore_missing_values (bool b)
virtual void	set_ignore_same_values (bool b)
virtual void	set_observation (const tom::calendars::date d, const tom::observation &val)
virtual void	set_observation (const tom::calendars::date_int_type d, const tom::observation &val)
virtual void	set_observation (tom::calendars::date d, const tom::Date &)
virtual void	set_observation (tom::calendars::date_int_type d, const tom::Date &)
Public Member Functions inherited from tom::tsdb::time_series
bool	alias_set_touched () const
virtual bool	exists () const
size_t	get_added_aliases (alias_set &added) const
virtual alias_set &	get_alias_set ()
virtual const alias_set &	get_alias_set () const
const tom::String &	get_attribute (const char *att_name, bool check_datastore=true) const
const tom::String &	get_attribute (const tom::observation &att_name, bool check_datastore=true) const
const tom::String &	get_attribute (const tom::String &att_name, bool check_datastore=true) const
virtual const attribute_set_t &	get_changed_attribute_names () const
size_t	get_dropped_aliases (alias_set &dropped) const
bool	operator!= (const time_series &rhs) const
bool	operator== (const time_series &rhs) const
virtual void	save (bool overwrite=false)
void	set_attribute (const char *att_name, const char *att_value)
void	set_attribute (const tom::observation &att_name, const tom::observation &att_value)
void	set_attribute (const tom::String &att_name, const tom::String &att_value)
Public Member Functions inherited from tom::collections::time_series
virtual const void *	data () const
date	get_first_date () const
date	get_last_date () const
void	set_observation (const Date &d, bool f)
virtual void	set_observation (const Date &d, const char *f)
virtual void	set_observation (const Date &d, const observation &val)
virtual void	set_observation (const Date &d, const std::string &f)
void	set_observation (const Date &d, double f)
void	set_observation (const Date &d, float f)
void	set_observation (const Date &d, int f)
void	set_observation (const Date &d, tom::value_type f)
void	set_observation (date d, bool f)
virtual void	set_observation (date d, const char *f)
virtual void	set_observation (date d, const std::string &f)
void	set_observation (date d, double f)
void	set_observation (date d, float f)
void	set_observation (date d, int f)
void	set_observation (date d, tom::value_type f)
void	set_observation (date_int_type d, bool f)
virtual void	set_observation (date_int_type d, const char *f)
virtual void	set_observation (date_int_type d, const std::string &f)
void	set_observation (date_int_type d, double f)
void	set_observation (date_int_type d, float f)
void	set_observation (date_int_type d, int f)
void	set_observation (date_int_type d, tom::value_type f)

Protected Member Functions
virtual void	set_create_date_time (const tom::calendars::date_time &d)
virtual void	set_modify_date_time (const tom::calendars::date_time &d)
Protected Member Functions inherited from tom::tsdb::time_series
bool	populate_alias_set () const
Protected Member Functions inherited from tom::collections::time_series
date_int_type	set_first_date_int (const date_int_type d)
date_int_type	set_last_date_int (const date_int_type d)

Protected Attributes
aggregation_type	m_agg_type
tom::calendars::date_time	m_create_date_time
tom::collections::sparse_series_impl< T >	m_data
datastore &	m_ds
tom::calendars::date_time	m_modify_date_time
tom::string	m_name
Protected Attributes inherited from tom::tsdb::time_series
alias_set	m_alias_set
bool	m_alias_set_touched
attribute_map_t	m_attributes
attribute_set_t	m_changed_attributes
alias_set	m_original_alias_set
Protected Attributes inherited from tom::collections::time_series
date_int_type	m_end_date_int
date_int_type	m_start_date_int

Member Function Documentation

begin()

template<typename T , typename NATIVE_TYPE >

tom::collections::time_series_iterator & tom::tsdb::collections::sparse_series< T, NATIVE_TYPE >::begin ( ) const

virtual

Implements tom::collections::time_series.

end()

template<typename T , typename NATIVE_TYPE >

tom::collections::time_series_iterator & tom::tsdb::collections::sparse_series< T, NATIVE_TYPE >::end ( ) const

virtual

Implements tom::collections::time_series.

get_aggregation_type()

template<typename T , typename NATIVE_TYPE >

aggregation_type tom::tsdb::collections::sparse_series< T, NATIVE_TYPE >::get_aggregation_type ( ) const

virtual

get the aggregation_type for the time_series object

Implements tom::tsdb::time_series.

get_calendar()

template<typename T , typename NATIVE_TYPE >

tom::calendars::calendar & tom::tsdb::collections::sparse_series< T, NATIVE_TYPE >::get_calendar ( ) const

virtual

Implements tom::collections::time_series.

get_create_date_time()

template<typename T , typename NATIVE_TYPE >

virtual const tom::calendars::date_time & tom::tsdb::collections::sparse_series< T, NATIVE_TYPE >::get_create_date_time ( ) const

inlinevirtual

get the date_time of the time_series objects creation within the datastore.

Implements tom::tsdb::time_series.

get_data_type()

template<typename T , typename NATIVE_TYPE >

virtual const values::data_type & tom::tsdb::collections::sparse_series< T, NATIVE_TYPE >::get_data_type ( ) const

inlinevirtual

get the data_type for the time_series object.

Implements tom::tsdb::time_series.

get_datastore()

template<typename T , typename NATIVE_TYPE >

virtual datastore & tom::tsdb::collections::sparse_series< T, NATIVE_TYPE >::get_datastore ( ) const

inlinevirtual

get the parent datastore for the time_series object.

Implements tom::tsdb::time_series.

get_fill_forward()

template<typename T , typename NATIVE_TYPE >

virtual bool tom::tsdb::collections::sparse_series< T, NATIVE_TYPE >::get_fill_forward ( ) const

inlinevirtual

Implements tom::tsdb::sparse_series.

get_first_date_int()

template<typename T , typename NATIVE_TYPE >

tom::calendars::date_int_type tom::tsdb::collections::sparse_series< T, NATIVE_TYPE >::get_first_date_int ( ) const

virtual

Reimplemented from tom::collections::time_series.

get_first_dirty_date_int()

template<typename T , typename NATIVE_TYPE >

virtual tom::calendars::date_int_type tom::tsdb::collections::sparse_series< T, NATIVE_TYPE >::get_first_dirty_date_int ( ) const

inlinevirtual

get the date_int_type for the earliest changed observation. This is mainly useful for persistence back-ends, but may be useful for you too.

Implements tom::tsdb::time_series.

get_ignore_missing_values()

template<typename T , typename NATIVE_TYPE >

virtual bool tom::tsdb::collections::sparse_series< T, NATIVE_TYPE >::get_ignore_missing_values ( ) const

inlinevirtual

Implements tom::tsdb::sparse_series.

get_ignore_same_values()

template<typename T , typename NATIVE_TYPE >

virtual bool tom::tsdb::collections::sparse_series< T, NATIVE_TYPE >::get_ignore_same_values ( ) const

inlinevirtual

Implements tom::tsdb::sparse_series.

get_last_date_int()

template<typename T , typename NATIVE_TYPE >

tom::calendars::date_int_type tom::tsdb::collections::sparse_series< T, NATIVE_TYPE >::get_last_date_int ( ) const

virtual

Reimplemented from tom::collections::time_series.

get_last_dirty_date_int()

template<typename T , typename NATIVE_TYPE >

virtual tom::calendars::date_int_type tom::tsdb::collections::sparse_series< T, NATIVE_TYPE >::get_last_dirty_date_int ( ) const

inlinevirtual

get the date_int_type for the latest changed observation. This is mainly useful for persistence back-ends, but may be useful for you too.

Implements tom::tsdb::time_series.

get_modify_date_time()

template<typename T , typename NATIVE_TYPE >

virtual const tom::calendars::date_time & tom::tsdb::collections::sparse_series< T, NATIVE_TYPE >::get_modify_date_time ( ) const

inlinevirtual

get the date_time of the time_series objects last modification within the datastore.

Implements tom::tsdb::time_series.

get_name()

template<typename T , typename NATIVE_TYPE >

virtual const tom::string & tom::tsdb::collections::sparse_series< T, NATIVE_TYPE >::get_name ( ) const

inlinevirtual

get the name or identifier for a time_series.

Implements tom::tsdb::time_series.

get_observation() [1/2]

template<typename T , typename NATIVE_TYPE >

const tom::observation & tom::tsdb::collections::sparse_series< T, NATIVE_TYPE >::get_observation ( const tom::calendars::date  d ) const

virtual

Implements tom::collections::time_series.

get_observation() [2/2]

template<typename T , typename NATIVE_TYPE >

const tom::observation & tom::tsdb::collections::sparse_series< T, NATIVE_TYPE >::get_observation ( const tom::calendars::date_int_type  d ) const

virtual

Implements tom::collections::time_series.

get_raw_data()

template<typename T , typename NATIVE_TYPE >

virtual const void * tom::tsdb::collections::sparse_series< T, NATIVE_TYPE >::get_raw_data ( ) const

inlinevirtual

Implements tom::tsdb::time_series.

is_sparse_series()

template<typename T , typename NATIVE_TYPE >

virtual bool tom::tsdb::collections::sparse_series< T, NATIVE_TYPE >::is_sparse_series ( ) const

inlinevirtual

indicates if the time_series contains only sparse data, or data at near regular intervals

Implements tom::tsdb::time_series.

operator[]() [1/4]

template<typename T , typename NATIVE_TYPE >

tom::observation & tom::tsdb::collections::sparse_series< T, NATIVE_TYPE >::operator[] ( const tom::calendars::date  d )

virtual

Implements tom::collections::time_series.

operator[]() [2/4]

template<typename T , typename NATIVE_TYPE >

const tom::observation & tom::tsdb::collections::sparse_series< T, NATIVE_TYPE >::operator[] ( const tom::calendars::date  d ) const

virtual

Implements tom::collections::time_series.

operator[]() [3/4]

template<typename T , typename NATIVE_TYPE >

tom::observation & tom::tsdb::collections::sparse_series< T, NATIVE_TYPE >::operator[] ( const tom::calendars::date_int_type  d )

virtual

Implements tom::collections::time_series.

operator[]() [4/4]

template<typename T , typename NATIVE_TYPE >

const tom::observation & tom::tsdb::collections::sparse_series< T, NATIVE_TYPE >::operator[] ( const tom::calendars::date_int_type  d ) const

virtual

Implements tom::collections::time_series.

print()

template<typename T , typename NATIVE_TYPE >

std::ostream & tom::tsdb::collections::sparse_series< T, NATIVE_TYPE >::print ( std::ostream &  os ) const

virtual

Implements tom::collections::time_series.

set_aggregation_type()

template<typename T , typename NATIVE_TYPE >

void tom::tsdb::collections::sparse_series< T, NATIVE_TYPE >::set_aggregation_type ( aggregation_type  )

virtual

set the aggregation type for the time_series object

Implements tom::tsdb::time_series.

set_create_date_time()

template<typename T , typename NATIVE_TYPE >

virtual void tom::tsdb::collections::sparse_series< T, NATIVE_TYPE >::set_create_date_time ( const tom::calendars::date_time &  d )

inlineprotectedvirtual

Implements tom::tsdb::time_series.

set_fill_forward()

template<typename T , typename NATIVE_TYPE >

virtual void tom::tsdb::collections::sparse_series< T, NATIVE_TYPE >::set_fill_forward ( bool  b )

inlinevirtual

Implements tom::tsdb::sparse_series.

set_ignore_missing_values()

template<typename T , typename NATIVE_TYPE >

virtual void tom::tsdb::collections::sparse_series< T, NATIVE_TYPE >::set_ignore_missing_values ( bool  b )

inlinevirtual

Implements tom::tsdb::sparse_series.

set_ignore_same_values()

template<typename T , typename NATIVE_TYPE >

virtual void tom::tsdb::collections::sparse_series< T, NATIVE_TYPE >::set_ignore_same_values ( bool  b )

inlinevirtual

Implements tom::tsdb::sparse_series.

set_modify_date_time()

template<typename T , typename NATIVE_TYPE >

virtual void tom::tsdb::collections::sparse_series< T, NATIVE_TYPE >::set_modify_date_time ( const tom::calendars::date_time &  d )

inlineprotectedvirtual

Implements tom::tsdb::time_series.

set_observation() [1/4]

template<typename T , typename NATIVE_TYPE >

void tom::tsdb::collections::sparse_series< T, NATIVE_TYPE >::set_observation ( const tom::calendars::date  d, const tom::observation &  val  )

virtual

Implements tom::collections::time_series.

set_observation() [2/4]

template<typename T , typename NATIVE_TYPE >

void tom::tsdb::collections::sparse_series< T, NATIVE_TYPE >::set_observation ( const tom::calendars::date_int_type  d, const tom::observation &  val  )

virtual

Implements tom::collections::time_series.

set_observation() [3/4]

template<typename T , typename NATIVE_TYPE >

void tom::tsdb::collections::sparse_series< T, NATIVE_TYPE >::set_observation ( tom::calendars::date  d, const tom::Date &  val  )

virtual

Implements tom::collections::time_series.

set_observation() [4/4]

template<typename T , typename NATIVE_TYPE >

void tom::tsdb::collections::sparse_series< T, NATIVE_TYPE >::set_observation ( tom::calendars::date_int_type  d, const tom::Date &  val  )

virtual

Implements tom::collections::time_series.

---

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

• tom-tsdb/sparse_series.hpp