Tawara  0.1.0
string_element.h
Go to the documentation of this file.
1 /*
2  * Software License Agreement (BSD License)
3  *
4  * Copyright (c) 2011, 2012, Geoffrey Biggs, geoffrey.biggs@aist.go.jp
5  * RT-Synthesis Research Group
6  * Intelligent Systems Research Institute,
7  * National Institute of Advanced Industrial Science and Technology (AIST),
8  * Japan
9  * All rights reserved.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  *
15  * * Redistributions of source code must retain the above copyright
16  * notice, this list of conditions and the following disclaimer.
17  * * Redistributions in binary form must reproduce the above
18  * copyright notice, this list of conditions and the following
19  * disclaimer in the documentation and/or other materials provided
20  * with the distribution.
21  * * Neither the name of Geoffrey Biggs nor AIST, nor the names of its
22  * contributors may be used to endorse or promote products derived
23  * from this software without specific prior written permission.
24  *
25  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
26  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
27  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
28  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
29  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
30  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
31  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
32  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
33  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
34  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
35  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
36  * POSSIBILITY OF SUCH DAMAGE.
37  */
38 
39 #if !defined(TAWARA_STRING_ELEMENT_H_)
40 #define TAWARA_STRING_ELEMENT_H_
41 
42 #include <tawara/prim_element.h>
43 #include <tawara/win_dll.h>
44 
45 #include <string>
46 
49 
50 namespace tawara
51 {
57  class TAWARA_EXPORT StringElement : public PrimitiveElement<std::string>
58  {
59  public:
66  StringElement(uint32_t id, std::string value);
67 
75  StringElement(uint32_t id, std::string value,
76  std::string default_value);
77 
79  virtual StringElement& operator=(std::string const& rhs);
80 
82  virtual uint64_t padding() const { return padding_; }
93  virtual void padding(uint64_t padding) { padding_ = padding; }
94 
96  virtual std::streamsize write_body(std::ostream& output);
97 
98  protected:
99  uint64_t padding_;
100 
102  virtual std::streamsize body_size() const;
103 
105  virtual std::streamsize read_body(std::istream& input,
106  std::streamsize size);
107  }; // class StringElement
108 }; // namespace tawara
109 
111 // group implementations
112 
113 #endif // TAWARA_STRING_ELEMENT_H_
114 
virtual void padding(uint64_t padding)
Set the amount of padding to use.
std::streamsize size(ID id)
Get the number of bytes required by an ID.
#define TAWARA_EXPORT
Definition: win_dll.h:51
String primitive element.
virtual uint64_t padding() const
Get the amount of padding used.
The primitive data element interface.
Definition: prim_element.h:76