![]() |
Eclipse SUMO - Simulation of Urban MObility
|
Output formatter for plain XML output. More...
#include <BinaryFormatter.h>
Public Types | |
enum | DataType { BF_BYTE, BF_INTEGER, BF_FLOAT, BF_STRING, BF_LIST, BF_XML_TAG_START, BF_XML_TAG_END, BF_XML_ATTRIBUTE, BF_EDGE, BF_LANE, BF_POSITION_2D, BF_POSITION_3D, BF_BOUNDARY, BF_COLOR, BF_NODE_TYPE, BF_EDGE_FUNCTION, BF_ROUTE, BF_SCALED2INT, BF_SCALED2INT_POSITION_2D, BF_SCALED2INT_POSITION_3D, BF_INVALID } |
data types in binary output More... | |
Public Member Functions | |
BinaryFormatter () | |
Constructor. More... | |
bool | closeTag (std::ostream &into, const std::string &comment="") |
Closes the most recently opened tag. More... | |
void | openTag (std::ostream &into, const std::string &xmlElement) |
Opens an XML tag. More... | |
void | openTag (std::ostream &into, const SumoXMLTag &xmlElement) |
Opens an XML tag. More... | |
template<> | |
void | writeAttr (std::ostream &into, const SumoXMLAttr attr, const bool &val) |
template<> | |
void | writeAttr (std::ostream &into, const SumoXMLAttr attr, const Boundary &val) |
template<> | |
void | writeAttr (std::ostream &into, const SumoXMLAttr attr, const double &val) |
template<> | |
void | writeAttr (std::ostream &into, const SumoXMLAttr attr, const int &val) |
template<> | |
void | writeAttr (std::ostream &into, const SumoXMLAttr attr, const Position &val) |
template<> | |
void | writeAttr (std::ostream &into, const SumoXMLAttr attr, const PositionVector &val) |
template<> | |
void | writeAttr (std::ostream &into, const SumoXMLAttr attr, const RGBColor &val) |
template<> | |
void | writeAttr (std::ostream &into, const SumoXMLAttr attr, const SumoXMLEdgeFunc &val) |
template<> | |
void | writeAttr (std::ostream &into, const SumoXMLAttr attr, const SumoXMLNodeType &val) |
template<> | |
void | writeAttr (std::ostream &into, const SumoXMLAttr, const std::vector< int > &val) |
template<typename E > | |
bool | writeHeader (std::ostream &into, const SumoXMLTag &rootElement) |
Writes a header with optional edge list and connections. More... | |
void | writePadding (std::ostream &, const std::string &) |
padding is ignored for binary output More... | |
void | writePreformattedTag (std::ostream &into, const std::string &val) |
writes a preformatted tag to the device but ensures that any pending tags are closed More... | |
bool | writeXMLHeader (std::ostream &into, const std::string &rootElement, const std::map< SumoXMLAttr, std::string > &attrs) |
Writes an XML header with optional configuration. More... | |
virtual | ~BinaryFormatter () |
Destructor. More... | |
Static Public Member Functions | |
template<typename dummy , typename T > | |
static void | writeAttr (dummy &into, const std::string &attr, const T &val) |
writes a named attribute More... | |
template<typename dummy > | |
static void | writeAttr (dummy &into, const SumoXMLAttr attr, const std::vector< const MSEdge * > &val) |
template<typename dummy > | |
static void | writeAttr (dummy &into, const SumoXMLAttr attr, const std::vector< const ROEdge * > &val) |
template<typename dummy , typename T > | |
static void | writeAttr (dummy &into, const SumoXMLAttr attr, const T &val) |
writes an arbitrary attribute More... | |
Static Private Member Functions | |
static void | writeAttrHeader (std::ostream &into, const SumoXMLAttr attr, const DataType type=BF_INVALID) |
writes the header for an arbitrary attribute More... | |
static void | writePosition (std::ostream &into, const Position &val) |
writes a position More... | |
static void | writeStaticHeader (std::ostream &into) |
writes the part of the header which is always unchanged. More... | |
static void | writeStringList (std::ostream &into, const std::vector< std::string > &list) |
writes a list of strings More... | |
Private Attributes | |
std::vector< SumoXMLTag > | myXMLStack |
The stack of begun xml elements. More... | |
Output formatter for plain XML output.
BinaryFormatter format XML like output into the output stream.
Definition at line 54 of file BinaryFormatter.h.
data types in binary output
Definition at line 57 of file BinaryFormatter.h.
BinaryFormatter::BinaryFormatter | ( | ) |
Constructor.
Definition at line 41 of file BinaryFormatter.cpp.
|
inlinevirtual |
Destructor.
Definition at line 107 of file BinaryFormatter.h.
|
virtual |
Closes the most recently opened tag.
[in] | into | The output stream to use |
Implements OutputFormatter.
Definition at line 108 of file BinaryFormatter.cpp.
References BF_XML_TAG_END, myXMLStack, and FileHelpers::writeByte().
|
virtual |
Opens an XML tag.
An indentation, depending on the current xml-element-stack size, is written followed by the given xml element ("<" + xmlElement) The xml element is added to the stack, then.
[in] | into | The output stream to use |
[in] | xmlElement | Name of element to open |
Implements OutputFormatter.
Definition at line 90 of file BinaryFormatter.cpp.
References SUMOXMLDefinitions::Tags.
Referenced by writeHeader(), and writeXMLHeader().
|
virtual |
Opens an XML tag.
Helper method which finds the correct string before calling openTag.
[in] | into | The output stream to use |
[in] | xmlElement | Id of the element to open |
Implements OutputFormatter.
Definition at line 98 of file BinaryFormatter.cpp.
References BF_XML_TAG_START, myXMLStack, and FileHelpers::writeByte().
|
static |
writes a named attribute
[in] | into | The output stream to use |
[in] | attr | The attribute (name) |
[in] | val | The attribute value |
Definition at line 297 of file BinaryFormatter.h.
References SUMOXMLDefinitions::Attrs, and writeAttr().
|
static |
Definition at line 324 of file BinaryFormatter.h.
References BF_ROUTE, writeAttrHeader(), and FileHelpers::writeEdgeVector().
|
static |
Definition at line 317 of file BinaryFormatter.h.
References BF_ROUTE, writeAttrHeader(), and FileHelpers::writeEdgeVector().
|
static |
writes an arbitrary attribute
[in] | into | The output stream to use |
[in] | attr | The attribute (name) |
[in] | val | The attribute value |
Definition at line 290 of file BinaryFormatter.h.
References BF_STRING, toString(), writeAttrHeader(), and FileHelpers::writeString().
Referenced by writeAttr(), OutputDevice::writeAttr(), and writeXMLHeader().
void BinaryFormatter::writeAttr | ( | std::ostream & | into, |
const SumoXMLAttr | attr, | ||
const bool & | val | ||
) |
Definition at line 119 of file BinaryFormatter.cpp.
References BF_BYTE, writeAttrHeader(), and FileHelpers::writeByte().
void BinaryFormatter::writeAttr | ( | std::ostream & | into, |
const SumoXMLAttr | attr, | ||
const Boundary & | val | ||
) |
Definition at line 205 of file BinaryFormatter.cpp.
References BF_BOUNDARY, writeAttrHeader(), FileHelpers::writeFloat(), Boundary::xmax(), Boundary::xmin(), Boundary::ymax(), and Boundary::ymin().
void BinaryFormatter::writeAttr | ( | std::ostream & | into, |
const SumoXMLAttr | attr, | ||
const double & | val | ||
) |
Definition at line 126 of file BinaryFormatter.cpp.
References BF_FLOAT, BF_SCALED2INT, writeAttrHeader(), FileHelpers::writeFloat(), and FileHelpers::writeInt().
void BinaryFormatter::writeAttr | ( | std::ostream & | into, |
const SumoXMLAttr | attr, | ||
const int & | val | ||
) |
Definition at line 138 of file BinaryFormatter.cpp.
References BF_INTEGER, writeAttrHeader(), and FileHelpers::writeInt().
void BinaryFormatter::writeAttr | ( | std::ostream & | into, |
const SumoXMLAttr | attr, | ||
const Position & | val | ||
) |
Definition at line 188 of file BinaryFormatter.cpp.
References writeAttrHeader(), and writePosition().
void BinaryFormatter::writeAttr | ( | std::ostream & | into, |
const SumoXMLAttr | attr, | ||
const PositionVector & | val | ||
) |
Definition at line 195 of file BinaryFormatter.cpp.
References BF_LIST, writeAttrHeader(), FileHelpers::writeInt(), and writePosition().
void BinaryFormatter::writeAttr | ( | std::ostream & | into, |
const SumoXMLAttr | attr, | ||
const RGBColor & | val | ||
) |
Definition at line 215 of file BinaryFormatter.cpp.
References RGBColor::alpha(), BF_COLOR, RGBColor::blue(), RGBColor::green(), RGBColor::red(), writeAttrHeader(), and FileHelpers::writeByte().
void BinaryFormatter::writeAttr | ( | std::ostream & | into, |
const SumoXMLAttr | attr, | ||
const SumoXMLEdgeFunc & | val | ||
) |
Definition at line 152 of file BinaryFormatter.cpp.
References BF_EDGE_FUNCTION, writeAttrHeader(), and FileHelpers::writeByte().
void BinaryFormatter::writeAttr | ( | std::ostream & | into, |
const SumoXMLAttr | attr, | ||
const SumoXMLNodeType & | val | ||
) |
Definition at line 145 of file BinaryFormatter.cpp.
References BF_NODE_TYPE, writeAttrHeader(), and FileHelpers::writeByte().
void BinaryFormatter::writeAttr | ( | std::ostream & | into, |
const | SumoXMLAttr, | ||
const std::vector< int > & | val | ||
) |
Definition at line 225 of file BinaryFormatter.cpp.
References BF_INTEGER, BF_LIST, FileHelpers::writeByte(), and FileHelpers::writeInt().
|
inlinestaticprivate |
writes the header for an arbitrary attribute
[in] | into | The output stream to use |
[in] | attr | The attribute (name) |
[in] | type | The attribute type |
Definition at line 216 of file BinaryFormatter.h.
References BF_INVALID, BF_XML_ATTRIBUTE, and FileHelpers::writeByte().
Referenced by writeAttr().
bool BinaryFormatter::writeHeader | ( | std::ostream & | into, |
const SumoXMLTag & | rootElement | ||
) |
Writes a header with optional edge list and connections.
If something has been written (myXMLStack is not empty), nothing is written and false returned. This header is only used by the binary formatter.
[in] | into | The output stream to use |
[in] | rootElement | The root element to use |
Definition at line 261 of file BinaryFormatter.h.
References BF_INTEGER, BF_LIST, BF_STRING, myXMLStack, openTag(), FileHelpers::writeByte(), FileHelpers::writeInt(), writeStaticHeader(), and FileHelpers::writeString().
|
inlinevirtual |
padding is ignored for binary output
Implements OutputFormatter.
Definition at line 198 of file BinaryFormatter.h.
|
staticprivate |
writes a position
[in] | into | The output stream to use |
[in] | val | the position to write |
Definition at line 158 of file BinaryFormatter.cpp.
References BF_POSITION_2D, BF_POSITION_3D, BF_SCALED2INT_POSITION_2D, BF_SCALED2INT_POSITION_3D, FileHelpers::writeByte(), FileHelpers::writeFloat(), FileHelpers::writeInt(), Position::x(), Position::y(), and Position::z().
Referenced by writeAttr().
|
inlinevirtual |
writes a preformatted tag to the device but ensures that any pending tags are closed
[in] | into | The output stream to use |
[in] | val | The preformatted data |
Implements OutputFormatter.
Definition at line 193 of file BinaryFormatter.h.
References FileHelpers::writeString().
|
staticprivate |
writes the part of the header which is always unchanged.
This method exists only to reduce include dependencies of BinaryFormatter.h (which promote to OutputDevice.h, ...)
[in] | into | The output stream to use |
Definition at line 46 of file BinaryFormatter.cpp.
References SUMOXMLDefinitions::Attrs, BF_BYTE, BF_STRING, SUMOXMLDefinitions::EdgeFunctions, SUMOXMLDefinitions::NodeTypes, SUMOXMLDefinitions::Tags, VERSION_STRING, FileHelpers::writeByte(), FileHelpers::writeString(), and writeStringList().
Referenced by writeHeader(), and writeXMLHeader().
|
staticprivate |
writes a list of strings
[in] | into | The output stream to use |
[in] | list | the list to write |
Definition at line 59 of file BinaryFormatter.cpp.
References BF_LIST, BF_STRING, FileHelpers::writeByte(), FileHelpers::writeInt(), and FileHelpers::writeString().
Referenced by writeStaticHeader(), and writeXMLHeader().
|
virtual |
Writes an XML header with optional configuration.
If something has been written (myXMLStack is not empty), nothing is written and false returned.
[in] | into | The output stream to use |
[in] | rootElement | The root element to use |
[in] | attrs | Additional attributes to save within the rootElement |
Implements OutputFormatter.
Definition at line 70 of file BinaryFormatter.cpp.
References myXMLStack, openTag(), SUMOXMLDefinitions::Tags, writeAttr(), writeStaticHeader(), and writeStringList().
|
private |
The stack of begun xml elements.
Definition at line 254 of file BinaryFormatter.h.
Referenced by closeTag(), openTag(), writeHeader(), and writeXMLHeader().