FileHelpers Class Reference

#include <FileHelpers.h>

---

Detailed Description

Functions for an easier usage of files and paths.

Definition at line 44 of file FileHelpers.h.

Static Public Member Functions
static std::ostream &	writeTime (std::ostream &strm, SUMOTime value)
	Writes a time description binary.
file path evaluating functions
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.
static std::string	getConfigurationRelative (const std::string &configPath, const std::string &path)
	Returns the second path as a relative path to the first file.
static std::string	getFilePath (const std::string &path)
	Removes the file information from the given path.
static bool	isAbsolute (const std::string &path)
	Returns the information whether the given path is absolute.
static bool	isSocket (const std::string &name)
	Returns the information whether the given name represents a socket.
file access functions
static bool	exists (std::string path)
	Checks whether the given file exists.
binary writing functions
static std::ostream &	writeByte (std::ostream &strm, unsigned char value)
	Writes a byte binary.
static std::ostream &	writeFloat (std::ostream &strm, SUMOReal value)
	Writes a float binary.
static std::ostream &	writeInt (std::ostream &strm, int value)
	Writes an integer binary.
static std::ostream &	writeString (std::ostream &strm, const std::string &value)
	Writes a string binary.
static std::ostream &	writeUInt (std::ostream &strm, unsigned int value)
	Writes an unsigned integer binary.

---

Member Function Documentation

std::string FileHelpers::checkForRelativity	(	std::string	filename,
		const std::string &	basePath
	)			[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).

See also:

isAbsolute

getConfigurationRelative

Parameters:

[in]	filename	The path to the file to be examined
[in]	basePath	The path the configuration file (including the config's file name)

Returns:

The file's position

Definition at line 118 of file FileHelpers.cpp.

References getConfigurationRelative(), and isAbsolute().

Referenced by OutputDevice::getDevice().

                                                           {
    if (!isAbsolute(filename)) {
        filename = getConfigurationRelative(basePath, filename);
    }
    return filename;
}

bool FileHelpers::exists

(

std::string

path

)

[static]

Checks whether the given file exists.

Parameters:

[in]

path

The path to the file that shall be examined

Returns:

Whether the named file exists

Definition at line 50 of file FileHelpers.cpp.

Referenced by NLBuilder::buildRouteLoaderControl(), OptionsCont::isUsableFileList(), OptionsIO::loadConfiguration(), loadDistricts(), PCNetProjectionLoader::loadIfSet(), PCLoaderXML::loadIfSet(), PCLoaderVisum::loadIfSet(), PCLoaderOSM::loadIfSet(), ROLoader::loadNet(), NIImporter_SUMO::loadNetwork(), NIImporter_RobocupRescue::loadNetwork(), NIImporter_OpenStreetMap::loadNetwork(), NIImporter_OpenDrive::loadNetwork(), NIImporter_ArcView::loadNetwork(), PCLoaderDlrNavteq::loadPOIFiles(), PCLoaderDlrNavteq::loadPolyFiles(), NILoader::loadXMLType(), readDetectorFlows(), and readDetectors().

                                  {
    if (path.length()==0) {
        return false;
    }
    while (path[path.length()-1]=='/'||path[path.length()-1]=='\\') {
        path.erase(path.end()-1);
    }
    if (path.length()==0) {
        return false;
    }
    struct stat st;
    bool ret = (stat(path.c_str(), &st) == 0);
    return ret;
}

std::string FileHelpers::getConfigurationRelative	(	const std::string &	configPath,
		const std::string &	path
	)			[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.

Parameters:

[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)

Returns:

The file's position (relative to curent working directory)

Definition at line 80 of file FileHelpers.cpp.

References getFilePath().

Referenced by checkForRelativity(), NLTriggerBuilder::getFileName(), GUISettingsHandler::myStartElement(), OptionsCont::relocateFiles(), and GenericSAXHandler::startElement().

                                                             {
    std::string retPath = getFilePath(configPath);
    return retPath + path;
}

std::string FileHelpers::getFilePath

(

const std::string &

path

)

[static]

Removes the file information from the given path.

Parameters:

[in]

path

The path to the file to return the folder it is located in

Returns:

The directory of the named file

Definition at line 70 of file FileHelpers.cpp.

Referenced by getConfigurationRelative(), RODFDetectorCon::writeEmitters(), and RODFDetectorCon::writeSpeedTrigger().

                                              {
    size_t beg = path.find_last_of("\\/");
    if (beg==std::string::npos||beg==0) {
        return "";
    }
    return path.substr(0, beg+1);
}

bool FileHelpers::isAbsolute

(

const std::string &

path

)

[static]

Returns the information whether the given path is absolute.

A path is meant to be absolute, if

• it is a socket
• it starts with a "/" (Linux)
• it has a ':' at the second position (Windows)

Parameters:

[in]

path

The path to examine

Returns:

Whether the path is absolute

Definition at line 95 of file FileHelpers.cpp.

References isSocket().

Referenced by checkForRelativity(), NLTriggerBuilder::getFileName(), GUISettingsHandler::myStartElement(), OptionsCont::relocateFiles(), and GenericSAXHandler::startElement().

                                             {
    if (isSocket(path)) {
        return true;
    }
    // check UNIX - absolute paths
    if (path.length()>0&&path[0]=='/') {
        return true;
    }
    // check Windows - absolute paths
    if (path.length()>0&&path[0]=='\\') {
        return true;
    }
    if (path.length()>1&&path[1]==':') {
        return true;
    }
    if (path=="nul"||path=="NUL") {
        return true;
    }
    return false;
}

bool FileHelpers::isSocket

(

const std::string &

name

)

[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.

Parameters:

[in]

name

The name of a file

Returns:

Whether the name names a socket

Definition at line 88 of file FileHelpers.cpp.

Referenced by OutputDevice::getDevice(), and isAbsolute().

                                           {
    size_t colonPos = name.find(":");
    return (colonPos != std::string::npos) && (colonPos > 1);
}

std::ostream & FileHelpers::writeByte	(	std::ostream &	strm,
		unsigned char	value
	)			[static]

Writes a byte binary.

Parameters:

[in,out]	strm	The stream to write into
[in]	value	The byte to write

Returns:

Reference to the stream

Definition at line 152 of file FileHelpers.cpp.

                                                            {
    strm.write((char*) &value, sizeof(char));
    return strm;
}

std::ostream & FileHelpers::writeFloat	(	std::ostream &	strm,
		SUMOReal	value
	)			[static]

Writes a float binary.

This method behaves differently depending on the definition of SUMOReal at compile time.

Parameters:

[in,out]	strm	The stream to write into
[in]	value	The float to write

Returns:

Reference to the stream

Definition at line 145 of file FileHelpers.cpp.

References SUMOReal.

Referenced by MSVehicleType::saveState(), and MSVehicle::saveState().

                                                        {
    strm.write((char*) &value, sizeof(SUMOReal));
    return strm;
}

std::ostream & FileHelpers::writeInt	(	std::ostream &	strm,
		int	value
	)			[static]

Writes an integer binary.

Parameters:

[in,out]	strm	The stream to write into
[in]	value	The integer to write

Returns:

Reference to the stream

Definition at line 131 of file FileHelpers.cpp.

Referenced by MSVehicleType::saveState(), and MSVehicle::saveState().

                                                 {
    strm.write((char*) &value, sizeof(int));
    return strm;
}

std::ostream & FileHelpers::writeString	(	std::ostream &	strm,
		const std::string &	value
	)			[static]

Writes a string binary.

Writes the length of the string, first, using writeInt. Writes then the string's characters.

See also:

writeInt

Parameters:

[in,out]	strm	The stream to write into
[in]	value	The string to write

Returns:

Reference to the stream

Definition at line 159 of file FileHelpers.cpp.

References size, and writeUInt().

Referenced by MSVehicleType::saveState(), and MSVehicle::saveState().

                                                                 {
    size_t size = value.length();
    const char *cstr = value.c_str();
    writeUInt(strm, (unsigned int) size);
    strm.write((char*) cstr, (std::streamsize)(sizeof(char)*size));
    return strm;
}

std::ostream & FileHelpers::writeTime	(	std::ostream &	strm,
		SUMOTime	value
	)			[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.

Parameters:

[in,out]	strm	The stream to write into
[in]	value	The time to write

Returns:

Reference to the stream

Definition at line 169 of file FileHelpers.cpp.

Referenced by MSVehicle::saveState().

                                                       {
    strm.write((char*) &value, sizeof(SUMOTime));
    return strm;
}

std::ostream & FileHelpers::writeUInt	(	std::ostream &	strm,
		unsigned int	value
	)			[static]

Writes an unsigned integer binary.

Parameters:

[in,out]	strm	The stream to write into
[in]	value	The unsigned integer to write

Returns:

Reference to the stream

Definition at line 138 of file FileHelpers.cpp.

Referenced by MSVehicle::saveState(), and writeString().

                                                           {
    strm.write((char*) &value, sizeof(unsigned int));
    return strm;
}

---

The documentation for this class was generated from the following files:

• FileHelpers.h
• FileHelpers.cpp