teca_dataset.h

#ifndef teca_dataset_h
#define teca_dataset_h
 
#include "teca_variant_array.h"
#include "teca_dataset_fwd.h"
#include <iosfwd>
class teca_binary_stream;
class teca_metadata;
 
class teca_dataset : public std::enable_shared_from_this<teca_dataset>
{
public:
    virtual ~teca_dataset();
 
    // the name of the key that holds the index identifing this dataset
    // this should be set by the algorithm that creates the dataset.
    TECA_DATASET_METADATA(index_request_key, std::string, 1)
 
    // a dataset metadata that uses the value of index_request_key to
    // store the index that identifies this dataset. this should be set
    // by the algorithm that creates the dataset.
    virtual int get_request_index(long &val) const;
    virtual int set_request_index(const std::string &key, long val);
    virtual int set_request_index(long val);
 
    // covert to bool. true if the dataset is not empty.
    // otherwise false.
    explicit operator bool() const noexcept
    { return !this->empty(); }
 
    // return true if the dataset is empty.
    virtual bool empty() const noexcept
    { return true; }
 
    // virtual constructor. return a new dataset of the same type.
    virtual p_teca_dataset new_instance() const = 0;
 
    // virtual copy constructor. return a shallow/deep copy of this
    // dataset in a new instance.
    virtual p_teca_dataset new_copy() const = 0;
    virtual p_teca_dataset new_shallow_copy() = 0;
 
    // return a string identifier uniquely naming the dataset type
    virtual std::string get_class_name() const = 0;
 
    // return an integer identifier uniquely naming the dataset type
    virtual int get_type_code() const = 0;
 
    // copy data and metadata. shallow copy uses reference
    // counting, while copy duplicates the data.
    virtual void copy(const const_p_teca_dataset &other);
    virtual void shallow_copy(const p_teca_dataset &other);
 
    // copy metadata. always a deep copy.
    virtual void copy_metadata(const const_p_teca_dataset &other);
 
    // swap internals of the two objects
    virtual void swap(p_teca_dataset &other);
 
    // access metadata
    virtual teca_metadata &get_metadata() noexcept;
    virtual const teca_metadata &get_metadata() const noexcept;
    virtual void set_metadata(const teca_metadata &md);
 
    // serialize the dataset to/from the given stream
    // for I/O or communication
    virtual int to_stream(teca_binary_stream &) const;
    virtual int from_stream(teca_binary_stream &);
 
    // stream to/from human readable representation
    virtual int to_stream(std::ostream &) const;
    virtual int from_stream(std::istream &);
 
protected:
    teca_dataset();
 
    teca_dataset(const teca_dataset &) = delete;
    teca_dataset(const teca_dataset &&) = delete;
 
    void operator=(const p_teca_dataset &other) = delete;
    void operator=(p_teca_dataset &&other) = delete;
 
    teca_metadata *metadata;
};
 
#endif