element.h

Go to the documentation of this file.

/* Tide
 *
 * Header file for the base element object.
 *
 * Copyright 2011 Geoffrey Biggs geoffrey.biggs@aist.go.jp
 *     RT-Synthesis Research Group
 *     Intelligent Systems Research Institute,
 *     National Institute of Advanced Industrial Science and Technology (AIST),
 *     Japan
 *     All rights reserved.
 *
 * This file is part of Tide.
 *
 * Tide is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2.1 of the License, or
 * (at your option) any later version.
 *
 * Tide is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
 * License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with Tide. If not, see <http://www.gnu.org/licenses/>.
 */

#if !defined(TIDE_ELEMENT_H_)
#define TIDE_ELEMENT_H_

#include <tide/el_ids.h>
#include <tide/win_dll.h>

#include <ios>
#include <iostream>
#include <stdint.h>



namespace tide
{
    class TIDE_EXPORT Element
    {
        public:
            Element(tide::ids::ID id);

            virtual ~Element() {};

            uint32_t id() const { return id_; }

            std::streampos offset() const { return offset_; }

            virtual std::streamsize size() const;

            virtual std::streamsize write(std::ostream& output);

            virtual std::streamsize read(std::istream& input);

        protected:
            tide::ids::ID id_;
            std::streampos offset_;

            virtual std::streamsize body_size() const = 0;

            std::streamsize write_id(std::ostream& output);

            virtual std::streamsize write_size(std::ostream& output);

            virtual std::streamsize write_body(std::ostream& output) = 0;

            virtual std::streamsize read_body(std::istream& input,
                    std::streamsize size) = 0;

    }; // class Element


    std::streamsize skip_read(std::istream& input, bool and_id);


    std::streamsize skip_write(std::iostream& stream, bool and_id);
}; // namespace tide


#endif // TIDE_ELEMENT_H_