SUMO - Simulation of Urban MObility
|
Functions for an easier usage of files and paths. More...
#include <FileHelpers.h>
Public Member Functions | |
template<typename E > | |
void | readEdgeVector (std::istream &in, std::vector< const E * > &edges, const std::string &rid) |
template<typename E > | |
std::ostream & | writeEdgeVector (std::ostream &os, const std::vector< E > &edges) |
Static Public Member Functions | |
file access functions | |
static bool | exists (std::string path) |
Checks whether the given file exists. More... | |
file path evaluating functions | |
static std::string | getFilePath (const std::string &path) |
Removes the file information from the given path. More... | |
static std::string | getConfigurationRelative (const std::string &configPath, const std::string &path) |
Returns the second path as a relative path to the first file. More... | |
static bool | isSocket (const std::string &name) |
Returns the information whether the given name represents a socket. More... | |
static bool | isAbsolute (const std::string &path) |
Returns the information whether the given path is absolute. More... | |
static std::string | checkForRelativity (std::string filename, const std::string &basePath) |
Returns the path from a configuration so that it is accessable from the current working directory. More... | |
binary writing functions | |
static std::ostream & | writeInt (std::ostream &strm, int value) |
Writes an integer binary. More... | |
static std::ostream & | writeUInt (std::ostream &strm, unsigned int value) |
Writes an unsigned integer binary. More... | |
static std::ostream & | writeFloat (std::ostream &strm, SUMOReal value) |
Writes a float binary. More... | |
static std::ostream & | writeByte (std::ostream &strm, unsigned char value) |
Writes a byte binary. More... | |
static std::ostream & | writeString (std::ostream &strm, const std::string &value) |
Writes a string binary. More... | |
static std::ostream & | writeTime (std::ostream &strm, SUMOTime value) |
Writes a time description binary. More... | |
template<typename E > | |
static std::ostream & | writeEdgeVector (std::ostream &os, const std::vector< E > &edges) |
Writes an edge vector binary. More... | |
template<typename E > | |
static void | readEdgeVector (std::istream &in, std::vector< const E * > &edges, const std::string &rid) |
Reads an edge vector binary. More... | |
Functions for an easier usage of files and paths.
Definition at line 48 of file FileHelpers.h.
|
static |
Returns the path from a configuration so that it is accessable from the current working directory.
If the path is absolute, it is returned. Otherwise, the file's position is computed regarding the configuration path (see getConfigurationRelative).
[in] | filename | The path to the file to be examined |
[in] | basePath | The path the configuration file (including the config's file name) |
Definition at line 120 of file FileHelpers.cpp.
References getConfigurationRelative(), and isAbsolute().
Referenced by OutputDevice::getDevice().
|
static |
Checks whether the given file exists.
[in] | path | The path to the file that shall be examined |
Definition at line 52 of file FileHelpers.cpp.
Referenced by NIImporter_SUMO::_loadNetwork(), NLBuilder::buildRouteLoaderControl(), OptionsCont::isUsableFileList(), NIImporter_OpenStreetMap::load(), OptionsIO::loadConfiguration(), loadDistricts(), PCLoaderVisum::loadIfSet(), PCLoaderOSM::loadIfSet(), PCNetProjectionLoader::loadIfSet(), PCLoaderXML::loadIfSet(), loadNet(), ROLoader::loadNet(), NIImporter_RobocupRescue::loadNetwork(), NIImporter_ArcView::loadNetwork(), NIImporter_ITSUMO::loadNetwork(), NIImporter_MATSim::loadNetwork(), NIImporter_OpenDrive::loadNetwork(), PCLoaderDlrNavteq::loadPOIFiles(), PCLoaderDlrNavteq::loadPolyFiles(), NILoader::loadXMLType(), readDetectorFlows(), and readDetectors().
|
static |
Returns the second path as a relative path to the first file.
Given the position of the configuration file, and the information where a second file is relative to the configuration file's position, we want to known where this second file can be found. This method gets the path to the configuration file (including the configuration file name) and the path to get the relative position of and returns this relative position.
[in] | configPath | The path the configuration file (including the config's file name) |
[in] | path | The path to the references file (relativ to configuration path) |
Definition at line 82 of file FileHelpers.cpp.
References getFilePath().
Referenced by NLHandler::addPOI(), NLHandler::addPoly(), SUMOVehicleParserHelper::beginVTypeParsing(), checkForRelativity(), NLTriggerBuilder::getFileName(), GUISettingsHandler::myStartElement(), PCLoaderXML::myStartElement(), OptionsCont::relocateFiles(), and GenericSAXHandler::startElement().
|
static |
Removes the file information from the given path.
[in] | path | The path to the file to return the folder it is located in |
Definition at line 72 of file FileHelpers.cpp.
Referenced by getConfigurationRelative(), RODFDetectorCon::writeEmitters(), and RODFDetectorCon::writeSpeedTrigger().
|
static |
Returns the information whether the given path is absolute.
A path is meant to be absolute, if
[in] | path | The path to examine |
Definition at line 97 of file FileHelpers.cpp.
References isSocket().
Referenced by NLHandler::addPOI(), NLHandler::addPoly(), SUMOVehicleParserHelper::beginVTypeParsing(), checkForRelativity(), NLTriggerBuilder::getFileName(), GUISettingsHandler::myStartElement(), PCLoaderXML::myStartElement(), OptionsCont::relocateFiles(), and GenericSAXHandler::startElement().
|
static |
Returns the information whether the given name represents a socket.
A file name is meant to describe a socket address if a colon is found at a position larger than one.
[in] | name | The name of a file |
Definition at line 90 of file FileHelpers.cpp.
Referenced by OutputDevice::getDevice(), and isAbsolute().
|
static |
Reads an edge vector binary.
[in] | is | The stream to read from |
[out] | edges | The edge vector to write into |
Referenced by MSEdge::parseEdgesList(), and RORDLoader_SUMOBase::parseRoute().
void FileHelpers::readEdgeVector | ( | std::istream & | in, |
std::vector< const E * > & | edges, | ||
const std::string & | rid | ||
) |
Definition at line 278 of file FileHelpers.h.
|
static |
Writes a byte binary.
[in,out] | strm | The stream to write into |
[in] | value | The byte to write |
Definition at line 154 of file FileHelpers.cpp.
Referenced by BinaryFormatter::closeTag(), BinaryFormatter::openTag(), SUMOSAXAttributesImpl_Binary::SUMOSAXAttributesImpl_Binary(), BinaryFormatter::writeAttr(), BinaryFormatter::writeAttrHeader(), BinaryFormatter::writeHeader(), BinaryFormatter::writePosition(), BinaryFormatter::writeStringList(), and BinaryFormatter::writeXMLHeader().
|
static |
Writes an edge vector binary.
[in,out] | os | The stream to write into |
[in] | edges | The edges to write |
Referenced by BinaryFormatter::writeAttr().
std::ostream& FileHelpers::writeEdgeVector | ( | std::ostream & | os, |
const std::vector< E > & | edges | ||
) |
Definition at line 222 of file FileHelpers.h.
References writeInt(), and writeUInt().
|
static |
Writes a float binary.
This method behaves differently depending on the definition of SUMOReal at compile time.
[in,out] | strm | The stream to write into |
[in] | value | The float to write |
Definition at line 147 of file FileHelpers.cpp.
References SUMOReal.
Referenced by MSVehicleType::saveState(), BinaryFormatter::writeAttr(), and BinaryFormatter::writePosition().
|
static |
Writes an integer binary.
[in,out] | strm | The stream to write into |
[in] | value | The integer to write |
Definition at line 133 of file FileHelpers.cpp.
Referenced by MSVehicleType::saveState(), SUMOSAXAttributesImpl_Binary::SUMOSAXAttributesImpl_Binary(), BinaryFormatter::writeAttr(), writeEdgeVector(), BinaryFormatter::writeHeader(), BinaryFormatter::writePosition(), and BinaryFormatter::writeStringList().
|
static |
Writes a string binary.
Writes the length of the string, first, using writeInt. Writes then the string's characters.
[in,out] | strm | The stream to write into |
[in] | value | The string to write |
Definition at line 161 of file FileHelpers.cpp.
References writeUInt().
Referenced by MSVehicleType::saveState(), BinaryFormatter::writeAttr(), BinaryFormatter::writeHeader(), BinaryFormatter::writeStringList(), and BinaryFormatter::writeXMLHeader().
|
static |
Writes a time description binary.
This method behaves differently depending on the definition of SUMOTime at compile time, which in turn depends on the enabling of subsecond timesteps.
[in,out] | strm | The stream to write into |
[in] | value | The time to write |
Definition at line 171 of file FileHelpers.cpp.
|
static |
Writes an unsigned integer binary.
[in,out] | strm | The stream to write into |
[in] | value | The unsigned integer to write |
Definition at line 140 of file FileHelpers.cpp.
Referenced by writeEdgeVector(), and writeString().