TSADataDef.h

/*  ===================================================================
*
*                 T R A D I N G   S Y S T E M   A P I ™
*    Copyright © 1999 - 2014 by Peter Ritter ( TradingSystemAPI.com )
*                A L L   R I G H T S   R E S E R V E D
*
*     Consult your license regarding permissions and restrictions.
*             You may obtain a copy of the License at:
*     http://www.TradingSystemAPI.com/licenses/LICENSE-TSAPI-3.0.html
*
*  ====================================================================
*/

#ifndef TSA_DATA_DEF__INCLUDED
#define TSA_DATA_DEF__INCLUDED

#include "TSATypeDef.h"
#include "TSARecord.h"
//#include "TSASerialize.h"

namespace tsa {

    namespace fast{
        class database;
    }

    /*
    ** ================================================================
    ** >>>                 class data_def                           <<<
    ** ================================================================
    */

    class  column_defs : public object{//, public serialize::I{
        tsa_declare_testable;
        friend class fast::db_record;
    private:
        std::vector<fast::db_record::field_info> m_field_infos;
    public:
        column_defs(void);

        column_defs(column_defs&&);

        column_defs(const std::string& column_definition_string);

        column_defs(const char* column_definition_string);

        // Internal - Initializes @b self with the schema structure previously saved under @b data_def_name in @b series_base.
        column_defs(fast::database& series_base, const std::string& data_def_name);

        column_defs(const column_defs&);

        void operator=(const column_defs& other);

        bool defined(void)const;

        void from_string(const std::string& column_definition_string);

        std::string to_string(void)const;

        bool is_equal(const column_defs& other);

        void clear();

        void remove_column(const std::string& column_name);

        void add_column(type_t column_type, const std::string& column_name, size_t length = 1);
    public:

        size_t column_count(void)const;

        size_t size(void)const;

        size_t column_number(const std::string column_name)const;

        bool column_exists(const std::string column_name)const;

        type_t column_type(size_t position)const;

        const std::string& column_name(size_t position)const;

        size_t column_field_length(size_t position)const;

        type_t column_type(const std::string& field_name)const;

        size_t column_field_length(const std::string& column_name)const;

        bool has_pointer_field(void)const;
        std::vector<std::string> column_names(bool include_timestamp_field = false)const;
    public:
        void print(std::ostream& _stream)const;
        virtual std::ostream& write(std::ostream&)const;
        virtual std::istream& read(std::istream&);

        void Write(out_storage_stream&)const;//still need this for reading from BLOB
        void Read(in_storage_stream&);
        void random_columns(size_t max_num_fields, size_t max_string_len, bool unsigned_fields_ok = true);
    public:
        template<class Archive>
        void save(Archive & ar) const
        {
            ar(m_field_infos);
        }

        template<class Archive>
        void load(Archive & ar)
        {
            ar(m_field_infos);
        }
    };

    std::ostream& operator<<(std::ostream& stream, const column_defs& _col_def);

}

#endif