Eclipse SUMO - Simulation of Urban MObility
BinaryFormatter.cpp
Go to the documentation of this file.
1 /****************************************************************************/
2 // Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.org/sumo
3 // Copyright (C) 2012-2019 German Aerospace Center (DLR) and others.
4 // This program and the accompanying materials
5 // are made available under the terms of the Eclipse Public License v2.0
6 // which accompanies this distribution, and is available at
7 // http://www.eclipse.org/legal/epl-v20.html
8 // SPDX-License-Identifier: EPL-2.0
9 /****************************************************************************/
17 // Static storage of an output device and its base (abstract) implementation
18 /****************************************************************************/
19 
20 
21 // ===========================================================================
22 // included modules
23 // ===========================================================================
24 #include <config.h>
25 
26 #ifdef HAVE_VERSION_H
27 #include <version.h>
28 #endif
29 
30 #include <utils/common/RGBColor.h>
31 #include <utils/common/ToString.h>
35 #include <utils/geom/Boundary.h>
36 #include "BinaryFormatter.h"
37 
38 
39 // ===========================================================================
40 // member method definitions
41 // ===========================================================================
43 }
44 
45 
46 void
49  FileHelpers::writeByte(into, 2);
52  writeStringList(into, SUMOXMLDefinitions::Tags.getStrings());
53  writeStringList(into, SUMOXMLDefinitions::Attrs.getStrings());
56 }
57 
58 
59 void
60 BinaryFormatter::writeStringList(std::ostream& into, const std::vector<std::string>& list) {
62  FileHelpers::writeInt(into, (int)list.size());
63  for (std::vector<std::string>::const_iterator it = list.begin(); it != list.end(); ++it) {
65  FileHelpers::writeString(into, *it);
66  }
67 }
68 
69 
70 bool
72  const std::string& rootElement,
73  const std::map<SumoXMLAttr, std::string>& attrs) {
74  if (myXMLStack.empty()) {
75  writeStaticHeader(into);
76  writeStringList(into, std::vector<std::string>());
77  writeStringList(into, std::vector<std::string>());
78  if (SUMOXMLDefinitions::Tags.hasString(rootElement)) {
79  openTag(into, rootElement);
80  for (std::map<SumoXMLAttr, std::string>::const_iterator it = attrs.begin(); it != attrs.end(); ++it) {
81  writeAttr(into, it->first, it->second);
82  }
83  return true;
84  }
85  }
86  return false;
87 }
88 
89 
90 void
91 BinaryFormatter::openTag(std::ostream& into, const std::string& xmlElement) {
92  if (SUMOXMLDefinitions::Tags.hasString(xmlElement)) {
93  openTag(into, (const SumoXMLTag)(SUMOXMLDefinitions::Tags.get(xmlElement)));
94  }
95 }
96 
97 
98 void
99 BinaryFormatter::openTag(std::ostream& into, const SumoXMLTag& xmlElement) {
100  myXMLStack.push_back(xmlElement);
102  const int tagNum = (int)xmlElement;
103  FileHelpers::writeByte(into, static_cast<unsigned char>(tagNum % 256));
104  FileHelpers::writeByte(into, static_cast<unsigned char>(tagNum / 256));
105 }
106 
107 
108 bool
109 BinaryFormatter::closeTag(std::ostream& into, const std::string& /*comment*/) {
110  if (!myXMLStack.empty()) {
112  myXMLStack.pop_back();
113  return true;
114  }
115  return false;
116 }
117 
118 
119 template<>
120 void BinaryFormatter::writeAttr(std::ostream& into, const SumoXMLAttr attr, const bool& val) {
122  FileHelpers::writeByte(into, val);
123 }
124 
125 
126 template<>
127 void BinaryFormatter::writeAttr(std::ostream& into, const SumoXMLAttr attr, const double& val) {
128  if (into.precision() == 2 && val < 2e7 && val > -2e7) { // 2e7 is roughly INT_MAX/100
130  FileHelpers::writeInt(into, int(val * 100. + .5));
131  } else {
133  FileHelpers::writeFloat(into, val);
134  }
135 }
136 
137 
138 template<>
139 void BinaryFormatter::writeAttr(std::ostream& into, const SumoXMLAttr attr, const int& val) {
141  FileHelpers::writeInt(into, val);
142 }
143 
144 
145 template<>
146 void BinaryFormatter::writeAttr(std::ostream& into, const SumoXMLAttr attr, const SumoXMLNodeType& val) {
148  FileHelpers::writeByte(into, static_cast<unsigned char>(val));
149 }
150 
151 
152 template<>
153 void BinaryFormatter::writeAttr(std::ostream& into, const SumoXMLAttr attr, const SumoXMLEdgeFunc& val) {
155  FileHelpers::writeByte(into, static_cast<unsigned char>(val));
156 }
157 
158 
159 void BinaryFormatter::writePosition(std::ostream& into, const Position& val) {
160  if (val.z() != 0.) {
161  if (into.precision() == 2 && val.x() < 2e7 && val.x() > -2e7 &&
162  val.y() < 2e7 && val.y() > -2e7 && val.z() < 2e7 && val.z() > -2e7) { // 2e7 is roughly INT_MAX/100
164  FileHelpers::writeInt(into, int(val.x() * 100. + .5));
165  FileHelpers::writeInt(into, int(val.y() * 100. + .5));
166  FileHelpers::writeInt(into, int(val.z() * 100. + .5));
167  } else {
169  FileHelpers::writeFloat(into, val.x());
170  FileHelpers::writeFloat(into, val.y());
171  FileHelpers::writeFloat(into, val.z());
172  }
173  } else {
174  if (into.precision() == 2 && val.x() < 2e7 && val.x() > -2e7 &&
175  val.y() < 2e7 && val.y() > -2e7) { // 2e7 is roughly INT_MAX/100
177  FileHelpers::writeInt(into, int(val.x() * 100. + .5));
178  FileHelpers::writeInt(into, int(val.y() * 100. + .5));
179  } else {
181  FileHelpers::writeFloat(into, val.x());
182  FileHelpers::writeFloat(into, val.y());
183  }
184  }
185 }
186 
187 
188 template<>
189 void BinaryFormatter::writeAttr(std::ostream& into, const SumoXMLAttr attr, const Position& val) {
191  writePosition(into, val);
192 }
193 
194 
195 template<>
196 void BinaryFormatter::writeAttr(std::ostream& into, const SumoXMLAttr attr, const PositionVector& val) {
198  FileHelpers::writeInt(into, static_cast<int>(val.size()));
199  for (PositionVector::const_iterator pos = val.begin(); pos != val.end(); ++pos) {
200  writePosition(into, *pos);
201  }
202 }
203 
204 
205 template<>
206 void BinaryFormatter::writeAttr(std::ostream& into, const SumoXMLAttr attr, const Boundary& val) {
208  FileHelpers::writeFloat(into, val.xmin());
209  FileHelpers::writeFloat(into, val.ymin());
210  FileHelpers::writeFloat(into, val.xmax());
211  FileHelpers::writeFloat(into, val.ymax());
212 }
213 
214 
215 template<>
216 void BinaryFormatter::writeAttr(std::ostream& into, const SumoXMLAttr attr, const RGBColor& val) {
218  FileHelpers::writeByte(into, val.red());
219  FileHelpers::writeByte(into, val.green());
220  FileHelpers::writeByte(into, val.blue());
221  FileHelpers::writeByte(into, val.alpha());
222 }
223 
224 
225 template<>
226 void BinaryFormatter::writeAttr(std::ostream& into, const SumoXMLAttr /* attr */, const std::vector<int>& val) {
228  FileHelpers::writeInt(into, (int)val.size());
229  for (std::vector<int>::const_iterator it = val.begin(); it != val.end(); ++it) {
231  FileHelpers::writeInt(into, *it);
232  }
233 }
234 
235 
236 /****************************************************************************/
RGBColor::alpha
unsigned char alpha() const
Returns the alpha-amount of the color.
Definition: RGBColor.h:83
Boundary.h
ToString.h
BinaryFormatter::BF_SCALED2INT_POSITION_3D
Definition: BinaryFormatter.h:98
Boundary::ymin
double ymin() const
Returns minimum y-coordinate.
Definition: Boundary.cpp:131
Position::z
double z() const
Returns the z-position.
Definition: Position.h:67
BinaryFormatter::BF_XML_TAG_START
Definition: BinaryFormatter.h:70
FileHelpers.h
BinaryFormatter::writeStaticHeader
static void writeStaticHeader(std::ostream &into)
writes the part of the header which is always unchanged.
Definition: BinaryFormatter.cpp:47
FileHelpers::writeInt
static std::ostream & writeInt(std::ostream &strm, int value)
Writes an integer binary.
Definition: FileHelpers.cpp:175
Boundary::xmax
double xmax() const
Returns maximum x-coordinate.
Definition: Boundary.cpp:125
SumoXMLEdgeFunc
SumoXMLEdgeFunc
Numbers representing special SUMO-XML-attribute values for representing edge functions used in netbui...
Definition: SUMOXMLDefinitions.h:1074
BinaryFormatter::BF_LIST
Definition: BinaryFormatter.h:68
BinaryFormatter::BF_NODE_TYPE
Definition: BinaryFormatter.h:88
RGBColor::red
unsigned char red() const
Returns the red-amount of the color.
Definition: RGBColor.h:62
BinaryFormatter::BF_BYTE
Definition: BinaryFormatter.h:60
FileHelpers::writeFloat
static std::ostream & writeFloat(std::ostream &strm, double value)
Writes a float binary.
Definition: FileHelpers.cpp:182
FileHelpers::writeByte
static std::ostream & writeByte(std::ostream &strm, unsigned char value)
Writes a byte binary.
Definition: FileHelpers.cpp:189
PositionVector
A list of positions.
Definition: PositionVector.h:46
BinaryFormatter::BF_XML_TAG_END
Definition: BinaryFormatter.h:72
SumoXMLTag
SumoXMLTag
Numbers representing SUMO-XML - element names.
Definition: SUMOXMLDefinitions.h:42
RGBColor.h
BinaryFormatter::closeTag
bool closeTag(std::ostream &into, const std::string &comment="")
Closes the most recently opened tag.
Definition: BinaryFormatter.cpp:109
RGBColor
Definition: RGBColor.h:40
Boundary::xmin
double xmin() const
Returns minimum x-coordinate.
Definition: Boundary.cpp:119
BinaryFormatter::BF_SCALED2INT_POSITION_2D
Definition: BinaryFormatter.h:96
FileHelpers::writeString
static std::ostream & writeString(std::ostream &strm, const std::string &value)
Writes a string binary.
Definition: FileHelpers.cpp:196
SumoXMLNodeType
SumoXMLNodeType
Numbers representing special SUMO-XML-attribute values for representing node- (junction-) types used ...
Definition: SUMOXMLDefinitions.h:1049
BinaryFormatter::BF_SCALED2INT
Definition: BinaryFormatter.h:94
Boundary
A class that stores a 2D geometrical boundary.
Definition: Boundary.h:42
BinaryFormatter::openTag
void openTag(std::ostream &into, const std::string &xmlElement)
Opens an XML tag.
Definition: BinaryFormatter.cpp:91
Position
A point in 2D or 3D with translation and scaling methods.
Definition: Position.h:39
Position::x
double x() const
Returns the x-position.
Definition: Position.h:57
BinaryFormatter::BF_EDGE_FUNCTION
Definition: BinaryFormatter.h:90
BinaryFormatter::writeStringList
static void writeStringList(std::ostream &into, const std::vector< std::string > &list)
writes a list of strings
Definition: BinaryFormatter.cpp:60
SUMOXMLDefinitions::Attrs
static StringBijection< int > Attrs
The names of SUMO-XML attributes for use in netbuild.
Definition: SUMOXMLDefinitions.h:1357
RGBColor::green
unsigned char green() const
Returns the green-amount of the color.
Definition: RGBColor.h:69
BinaryFormatter::BF_POSITION_2D
Definition: BinaryFormatter.h:80
BinaryFormatter::writeXMLHeader
bool writeXMLHeader(std::ostream &into, const std::string &rootElement, const std::map< SumoXMLAttr, std::string > &attrs)
Writes an XML header with optional configuration.
Definition: BinaryFormatter.cpp:71
BinaryFormatter::myXMLStack
std::vector< SumoXMLTag > myXMLStack
The stack of begun xml elements.
Definition: BinaryFormatter.h:255
BinaryFormatter::BF_INTEGER
Definition: BinaryFormatter.h:62
BinaryFormatter::BF_POSITION_3D
Definition: BinaryFormatter.h:82
BinaryFormatter::BinaryFormatter
BinaryFormatter()
Constructor.
Definition: BinaryFormatter.cpp:42
Position::y
double y() const
Returns the y-position.
Definition: Position.h:62
SUMOXMLDefinitions::Tags
static StringBijection< int > Tags
The names of SUMO-XML elements for use in netbuild.
Definition: SUMOXMLDefinitions.h:1354
RGBColor::blue
unsigned char blue() const
Returns the blue-amount of the color.
Definition: RGBColor.h:76
SUMOXMLDefinitions::EdgeFunctions
static StringBijection< SumoXMLEdgeFunc > EdgeFunctions
edge functions
Definition: SUMOXMLDefinitions.h:1366
BinaryFormatter::writeAttrHeader
static void writeAttrHeader(std::ostream &into, const SumoXMLAttr attr, const DataType type=BF_INVALID)
writes the header for an arbitrary attribute
Definition: BinaryFormatter.h:217
BinaryFormatter::BF_STRING
Definition: BinaryFormatter.h:66
BinaryFormatter::writePosition
static void writePosition(std::ostream &into, const Position &val)
writes a position
Definition: BinaryFormatter.cpp:159
BinaryFormatter::BF_BOUNDARY
Definition: BinaryFormatter.h:84
config.h
BinaryFormatter::writeAttr
static void writeAttr(dummy &into, const SumoXMLAttr attr, const T &val)
writes an arbitrary attribute
Definition: BinaryFormatter.h:291
BinaryFormatter::BF_FLOAT
Definition: BinaryFormatter.h:64
SumoXMLAttr
SumoXMLAttr
Numbers representing SUMO-XML - attributes.
Definition: SUMOXMLDefinitions.h:373
VERSION_STRING
#define VERSION_STRING
Definition: config.h:207
PositionVector.h
BinaryFormatter.h
SUMOXMLDefinitions.h
SUMOXMLDefinitions::NodeTypes
static StringBijection< SumoXMLNodeType > NodeTypes
node types
Definition: SUMOXMLDefinitions.h:1363
Boundary::ymax
double ymax() const
Returns maximum y-coordinate.
Definition: Boundary.cpp:137
BinaryFormatter::BF_COLOR
Definition: BinaryFormatter.h:86