string_element.h

Go to the documentation of this file.

/* Tide
 *
 * Header file for the string 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_STRING_ELEMENT_H_)
#define TIDE_STRING_ELEMENT_H_

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

#include <string>


namespace tide
{
    class TIDE_EXPORT StringElement : public PrimitiveElement<std::string>
    {
        public:
            StringElement(uint32_t id, std::string value);

            StringElement(uint32_t id, std::string value,
                    std::string default_value);

            virtual StringElement& operator=(std::string const& rhs);

            virtual uint64_t padding() const { return padding_; }
            virtual void padding(uint64_t padding) { padding_ = padding; }

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

        protected:
            uint64_t padding_;

            virtual std::streamsize body_size() const;

            virtual std::streamsize read_body(std::istream& input,
                    std::streamsize size);
    }; // class StringElement
}; // namespace tide

// group implementations

#endif // TIDE_STRING_ELEMENT_H_