TECA
The Toolkit for Extreme Climate Analysis
Public Member Functions | Friends | List of all members
teca_metadata Class Reference

A generic container for meta data in the form of name=value pairs. More...

#include <teca_metadata.h>

Public Member Functions

 teca_metadata (const teca_metadata &other)
 
teca_metadata & operator= (const teca_metadata &other)
 
 teca_metadata (teca_metadata &&other) noexcept
 
teca_metadata & operator= (teca_metadata &&other) noexcept
 
unsigned int size () const
 
int size (const std::string &name, unsigned int &size) const noexcept
 
void resize (const std::string &name, unsigned int n)
 
template<typename T >
void declare (const std::string &name)
 
template<typename T >
void declare (const std::string &name, unsigned int n)
 
template<typename T >
int set (const std::string &name, const T &val)
 
template<typename T >
int set (const std::string &name, const T *val, unsigned int n)
 
template<typename T , unsigned int N>
int set (const std::string &name, const T(&val)[N])
 
template<typename T >
int set (const std::string &name, const std::set< T > &val)
 
template<typename T >
int set (const std::string &name, const std::vector< T > &val)
 
template<typename T >
int set (const std::string &name, std::initializer_list< T > val)
 
template<typename T >
int set (const std::string &name, const std::vector< std::vector< T >> &val)
 
int set (const std::string &name, const p_teca_variant_array &prop_val)
 
template<typename T >
int set (const std::string &name, const p_teca_variant_array_impl< T > &prop_val)
 
template<typename T >
int append (const std::string &name, const T &val)
 
template<typename T >
int update (const std::string &name, const T &val)
 
template<typename T >
int update (const std::string &name, unsigned int i, const T &val)
 
template<typename T >
int update (const std::string &name, const T *val, unsigned int n)
 
template<typename T >
int update (const std::string &name, const std::vector< T > &val)
 
template<typename T >
int update (const std::string &name, std::initializer_list< T > val)
 
template<typename T >
int update (const std::string &name, const std::set< T > &val)
 
int update (const std::string &name, p_teca_variant_array prop_val)
 
template<typename T >
int get (const std::string &name, T &val) const
 
template<typename T >
int get (const std::string &name, unsigned int i, T &val) const
 
template<typename T >
int get (const std::string &name, T *val, unsigned int n) const
 
template<typename T , unsigned int N>
int get (const std::string &name, T(&val)[N]) const
 
template<typename T >
int get (const std::string &name, std::vector< T > &val) const
 
template<typename T >
int get (const std::string &name, std::set< T > &val) const
 
int get (const std::string &name, p_teca_variant_array val) const
 
p_teca_variant_array get (const std::string &name)
 
const_p_teca_variant_array get (const std::string &name) const
 
int get_name (unsigned long i, std::string &name) const
 
int get_names (std::vector< std::string > &names) const
 
int remove (const std::string &name) noexcept
 
void clear ()
 
int has (const std::string &name) const noexcept
 
int empty () const noexcept
 
 operator bool () const noexcept
 
int to_stream (teca_binary_stream &s) const
 
int from_stream (teca_binary_stream &s)
 
int to_stream (std::ostream &os) const
 
int from_stream (std::ostream &)
 

Friends

bool operator< (const teca_metadata &, const teca_metadata &) noexcept
 
bool operator== (const teca_metadata &, const teca_metadata &) noexcept
 
teca_metadata operator& (const teca_metadata &, const teca_metadata &)
 

Detailed Description

A generic container for meta data in the form of name=value pairs.

Value arrays are supported. See metadata producer-consumer documentation for information about what names are valid.

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