ViSP  2.10.0
vpIoTools Class Reference

#include <vpIoTools.h>

Static Public Member Functions

static void getUserName (std::string &username)
 
static std::string getUserName ()
 
static std::string getenv (const char *env)
 
static std::string getenv (const std::string &env)
 
static std::string getViSPImagesDataPath ()
 
static void getVersion (const std::string &version, unsigned int &major, unsigned int &minor, unsigned int &patch)
 
static bool checkDirectory (const char *dirname)
 
static bool checkDirectory (const std::string &dirname)
 
static bool checkFilename (const char *filename)
 
static bool checkFilename (const std::string &filename)
 
static bool copy (const char *src, const char *dst)
 
static bool copy (const std::string &src, const std::string &dst)
 
static void makeDirectory (const char *dirname)
 
static void makeDirectory (const std::string &dirname)
 
static bool remove (const char *filename)
 
static bool remove (const std::string &filename)
 
static bool rename (const char *oldfilename, const char *newfilename)
 
static bool rename (const std::string &oldfilename, const std::string &newfilename)
 
static std::string path (const char *pathname)
 
static std::string path (const std::string &pathname)
 
static std::string getFileExtension (const std::string &pathname, const bool checkFile=false)
 
static std::string getName (const std::string &pathname)
 
static std::string getNameWE (const std::string &pathname)
 
static std::string getParent (const std::string &pathname)
 
static std::string createFilePath (const std::string &parent, const std::string child)
 
static bool isAbsolutePathname (const std::string &pathname)
 
static std::pair< std::string, std::string > splitDrive (const std::string &pathname)
 
static bool loadConfigFile (const std::string &confFile)
 
static bool readConfigVar (const std::string &var, float &value)
 
static bool readConfigVar (const std::string &var, double &value)
 
static bool readConfigVar (const std::string &var, int &value)
 
static bool readConfigVar (const std::string &var, unsigned int &value)
 
static bool readConfigVar (const std::string &var, bool &value)
 
static bool readConfigVar (const std::string &var, std::string &value)
 
static bool readConfigVar (const std::string &var, vpColor &value)
 
static bool readConfigVar (const std::string &var, vpMatrix &value, const unsigned int &nCols=0, const unsigned int &nRows=0)
 
static void setBaseName (const std::string &s)
 
static void setBaseDir (const std::string &dir)
 
static void addNameElement (const std::string &strTrue, const bool &cond=true, const std::string &strFalse="")
 
static void addNameElement (const std::string &strTrue, const double &val)
 
static std::string getBaseName ()
 
static std::string getFullName ()
 
static void saveConfigFile (const bool &actuallySave=true)
 
static void createBaseNamePath (const bool &empty=false)
 

Static Public Attributes

static const char separator
 

Static Protected Attributes

static std::string baseName = ""
 
static std::string baseDir = ""
 
static std::string configFile = ""
 
static std::vector< std::string > configVars = std::vector<std::string>()
 
static std::vector< std::string > configValues = std::vector<std::string>()
 

Detailed Description

File and directories basic tools.

The example below shows how to manipulate the functions of this class to create first a directory which name corresponds to the user name and then create a file in this directory.

#include <iostream>
#include <string>
#include <fstream>
#include <visp/vpIoTools.h>
int main()
{
std::string username;
// Test if a username directory exist. If no try to create it
if (vpIoTools::checkDirectory(username) == false) {
try {
// Create a directory with name "username"
}
catch (...) {
std::cout << "Cannot create " << username << " directory" << std::endl;
return false;
}
}
// Create a empty filename with name "username/file.txt"
std::ofstream f;
std::string filename = username + "/file.txt";
filename = vpIoTools::path(filename); // Under Windows converts the filename string into "username\\file.txt"
std::cout << "Create: " << filename << std::endl;
f.open(filename.c_str());
f.close();
// Rename the file
std::string newfilename = username + "/newfile.txt";
std::cout << "Rename: " << filename << " in: " << newfilename << std::endl;
if (vpIoTools::rename(filename, newfilename) == false)
std::cout << "Unable to rename: " << filename << std::endl;
// Remove the file
std::cout << "Remove: " << newfilename << std::endl;
if (vpIoTools::remove(newfilename) == false)
std::cout << "Unable to remove: " << newfilename << std::endl;
}

The example below shows how to read a configuration file and how to create a name for experiment files. We assume the following file "/home/user/demo/config.txt" :

expNumber 2
save 0
lambda 0.4
use2D 0
use3D 1
#include <iostream>
#include <string>
#include <visp/vpIoTools.h>
int main()
{
// reading configuration file
vpIoTools::loadConfigFile("/home/user/demo/config.txt");
std::string nExp;vpIoTools::readConfigVar("expNumber", nExp); // nExp <- "2"
double lambda;vpIoTools::readConfigVar("lambda", lambda); // lambda <- 0.4
bool use2D;vpIoTools::readConfigVar("use2D", use2D); // use2D <- false
bool use3D;vpIoTools::readConfigVar("use3D", use3D); // use3D <- true
bool doSave;vpIoTools::readConfigVar("save", doSave); // doSave <- false
// creating name for experiment files
vpIoTools::setBaseDir("/home/user/data");
vpIoTools::setBaseName("exp" + nExp); // full name <- "/home/user/data/exp2"
vpIoTools::addNameElement("2D", use2D); // full name <- "/home/user/data/exp2" since use2D==false
vpIoTools::addNameElement("3D", use3D); // full name <- "/home/user/data/exp2_3D"
vpIoTools::addNameElement("lambda", lambda); // full name <- "/home/user/data/exp2_3D_lambda0.4"
// saving file
vpIoTools::saveConfigFile(doSave); // would copy "/home/user/demo/config.txt" to "/home/user/data/exp2_3D_lambda0.4_config.txt" if doSave was true
// create sub directory
vpIoTools::createBaseNamePath(); // creates "/home/user/data/exp2_3D_lambda0.4/"
}

Definition at line 155 of file vpIoTools.h.

Member Function Documentation

void vpIoTools::addNameElement ( const std::string &  strTrue,
const bool &  cond = true,
const std::string &  strFalse = "" 
)
static

Augments the prefix of the experiment files by strTrue if cond is verified, and by strFalse otherwise.

Parameters
strTrue: String to add if cond is true
cond: Condition managing the file name
strFalse: String to add if cond is false (default "")

Definition at line 996 of file vpIoTools.cpp.

References baseName.

void vpIoTools::addNameElement ( const std::string &  strTrue,
const double &  val 
)
static

Augments the prefix of the experiment files by strTrue followed by val.

Parameters
strTrue: String to add
val: Value to add

Definition at line 1011 of file vpIoTools.cpp.

References baseName.

bool vpIoTools::checkDirectory ( const char *  dirname)
static

Check if a directory exists.

Parameters
dirname: Directory to test if it exists. The directory name is converted to the current system's format; see path().
Returns
true : If the directory exists and is accessible with write access.
false : If dirname string is null, or is not a directory, or has no write access.
See also
checkDirectory(const std::string &)
Examples:
displayD3D.cpp, displayGTK.cpp, displayOpenCV.cpp, displayX.cpp, displayXMulti.cpp, histogram.cpp, imageDiskRW.cpp, servoAfma4Point2DArtVelocity.cpp, servoAfma4Point2DCamVelocity.cpp, servoAfma4Point2DCamVelocityKalman.cpp, servoAfma6FourPoints2DArtVelocity.cpp, servoAfma6FourPoints2DCamVelocityInteractionCurrent.cpp, servoAfma6FourPoints2DCamVelocityInteractionDesired.cpp, servoAfma6Point2DArtVelocity.cpp, servoAfma6Point2DCamVelocity.cpp, servoAfma6Segment2DCamVelocity.cpp, servoBiclopsPoint2DArtVelocity.cpp, servoSimu3D_cdMc_CamVelocity.cpp, servoSimu3D_cdMc_CamVelocityWithoutVpServo.cpp, servoSimu3D_cMcd_CamVelocity.cpp, servoSimu3D_cMcd_CamVelocityWithoutVpServo.cpp, servoSimuFourPoints2DPolarCamVelocityDisplay.cpp, servoViper650FourPoints2DArtVelocityInteractionCurrent.cpp, servoViper650FourPoints2DCamVelocityInteractionCurrent.cpp, servoViper650Point2DCamVelocity.cpp, servoViper850FourPoints2DArtVelocityInteractionCurrent.cpp, servoViper850FourPoints2DArtVelocityInteractionDesired.cpp, servoViper850FourPoints2DCamVelocityInteractionCurrent.cpp, servoViper850FourPointsKinect.cpp, servoViper850Point2DArtVelocity.cpp, servoViper850Point2DCamVelocity.cpp, servoViper850Point2DCamVelocityKalman.cpp, SickLDMRS-Process.cpp, sonarPioneerReader.cpp, testConversion.cpp, testCreateSubImage.cpp, testIoPGM.cpp, testIoPPM.cpp, testRobust.cpp, testUndistortImage.cpp, and testXmlParser.cpp.

Definition at line 315 of file vpIoTools.cpp.

References path().

Referenced by checkDirectory(), copy(), createBaseNamePath(), getFileExtension(), vpSimulatorAfma6::init(), vpSimulatorViper850::init(), vpSimulatorAfma6::initArms(), vpSimulatorViper850::initArms(), makeDirectory(), vpServoData::open(), remove(), and vpWireFrameSimulator::vpWireFrameSimulator().

bool vpIoTools::checkDirectory ( const std::string &  dirname)
static

Check if a directory exists.

Parameters
dirname: Directory to test if it exists. The directory name is converted to the current system's format; see path().
Returns
true : If the directory exists and is accessible with write access.
false : If dirname string is null, or is not a directory, or has no write access.
See also
checkDirectory(const char *)

Definition at line 365 of file vpIoTools.cpp.

References checkDirectory().

bool vpIoTools::checkFilename ( const char *  filename)
static

Check if a file exists.

Parameters
filename: Filename to test if it exists.
Returns
true : If the filename exists and is accessible with read access.
false : If filename string is null, or is not a filename, or has no read access.
See also
checkFilename(const std::string &)
Examples:
fernClassifier.cpp, planarObjectDetector.cpp, tutorial-detection-object-mbt.cpp, tutorial-mb-edge-tracker.cpp, tutorial-mb-hybrid-tracker.cpp, and tutorial-mb-klt-tracker.cpp.

Definition at line 465 of file vpIoTools.cpp.

References path().

Referenced by checkFilename(), copy(), vpDot2::defineDots(), getFileExtension(), getViSPImagesDataPath(), vpAROgre::init(), vpMbTracker::initClick(), vpMbTracker::loadCAOModel(), vpMbTracker::loadModel(), vpImageIo::read(), and remove().

bool vpIoTools::checkFilename ( const std::string &  filename)
static

Check if a file exists.

Parameters
filename: Filename to test if it exists.
Returns
true : If the filename exists and is accessible with read access.
false : If filename string is null, or is not a filename, or has no read access.
See also
checkFilename(const char *)

Definition at line 513 of file vpIoTools.cpp.

References checkFilename().

bool vpIoTools::copy ( const char *  src,
const char *  dst 
)
static

Copy a src file or directory in dst.

Parameters
src: Existing file or directory to copy.
dst: New copied file or directory.
Returns
true if the file or the directory was copied, false otherwise.
See also
copy(const std::string &, const std::string &)

Definition at line 531 of file vpIoTools.cpp.

References checkDirectory(), checkFilename(), and path().

Referenced by copy(), and saveConfigFile().

bool vpIoTools::copy ( const std::string &  src,
const std::string &  dst 
)
static

Copy a src file or directory in dst.

Parameters
src: Existing file or directory to copy.
dst: New copied file or directory.
Returns
true if the file or the directory was copied, false otherwise.
See also
copy(const char *, const char *)

Definition at line 581 of file vpIoTools.cpp.

References copy().

void vpIoTools::createBaseNamePath ( const bool &  empty = false)
static

Creates the directory baseDir/baseName. If already exists, empties it if empty is true. Useful to save the images corresponding to a particular experiment.

Parameters
empty: Indicates if the new directory has to be emptied

Definition at line 1031 of file vpIoTools.cpp.

References baseDir, baseName, checkDirectory(), makeDirectory(), and remove().

std::string vpIoTools::createFilePath ( const std::string &  parent,
const std::string  child 
)
static
static std::string vpIoTools::getBaseName ( )
inlinestatic

Gets the base name (prefix) of the experiment files.

Returns
the base name of the experiment files.

Definition at line 234 of file vpIoTools.h.

std::string vpIoTools::getenv ( const char *  env)
static

Get the content of an environment variable.

Parameters
env: Environment variable name (HOME, LOGNAME...).
Returns
Value of the environment variable.
Exceptions
vpIoException::cantGetenv: If an error occur while getting the environment variable value.
#include <iostream>
#include <string>
#include <visp/vpIoTools.h>
int main()
{
std::string envvalue;
try {
envvalue = vpIoTools::getenv("HOME");
std::cout << "$HOME = \"" << envvalue << "\"" << std::endl;
}
catch (vpException &e) {
std::cout << e.getMessage() << std::endl;
return -1;
}
return 0;
}
See also
getenv(std::string &)

Definition at line 204 of file vpIoTools.cpp.

References vpIoException::cantGetenv, and vpERROR_TRACE.

Referenced by getenv(), getUserName(), getViSPImagesDataPath(), vpSimulatorAfma6::init(), vpSimulatorViper850::init(), vpSimulatorAfma6::initArms(), vpSimulatorViper850::initArms(), and vpWireFrameSimulator::vpWireFrameSimulator().

std::string vpIoTools::getenv ( const std::string &  env)
static

Get the content of an environment variable.

Parameters
env: Environment variable name (HOME, LOGNAME...).
Returns
Value of the environment variable
Exceptions
vpIoException::cantGetenv: If an error occur while getting the environment variable value.
#include <iostream>
#include <string>
#include <visp/vpIoTools.h>
int main()
{
std::string envvalue;
try {
std::string env = "HOME";
envvalue = vpIoTools::getenv(env);
std::cout << "$HOME = \"" << envvalue << "\"" << std::endl;
}
catch (vpException &e) {
std::cout << e.getMessage() << std::endl;
return -1;
}
return 0;
}
See also
getenv(const char *)

Definition at line 253 of file vpIoTools.cpp.

References getenv().

std::string vpIoTools::getFileExtension ( const std::string &  pathname,
const bool  checkFile = false 
)
static

Returns the extension of the file or an empty string if the file has no extension. If checkFile flag is set, it will check first if the pathname denotes a directory and so return an empty string and second it will check if the file denoted by the pathanme exists. If so, it will return the extension if present.

Parameters
pathname: The pathname of the file we want to get the extension.
checkFile: If true, the file must exist otherwise an empty string will be returned.
Returns
The extension of the file or an empty string if the file has no extension. or if the pathname is empty.
Examples:
testIoTools.cpp.

Definition at line 1105 of file vpIoTools.cpp.

References checkDirectory(), and checkFilename().

static std::string vpIoTools::getFullName ( )
inlinestatic

Gets the full path of the experiment files : baseDir/baseName

Returns
the full path of the experiment files.

Definition at line 240 of file vpIoTools.h.

std::string vpIoTools::getName ( const std::string &  pathname)
static

Returns the name of the file or directory denoted by this pathname.

Returns
The name of the file or directory denoted by this pathname, or an empty string if this pathname's name sequence is empty.
Examples:
testIoTools.cpp.

Definition at line 1185 of file vpIoTools.cpp.

References path(), and separator.

Referenced by getNameWE(), and vpMbTracker::loadCAOModel().

std::string vpIoTools::getNameWE ( const std::string &  pathname)
static

Returns the name of the file without extension or directory denoted by this pathname.

Returns
The name of the file without extension or directory denoted by this pathname, or an empty string if this pathname's name sequence is empty.
Examples:
tutorial-detection-object-mbt.cpp, tutorial-mb-edge-tracker.cpp, tutorial-mb-hybrid-tracker.cpp, and tutorial-mb-klt-tracker.cpp.

Definition at line 1207 of file vpIoTools.cpp.

References getName().

std::string vpIoTools::getParent ( const std::string &  pathname)
static

Returns the pathname string of this pathname's parent.

Returns
The pathname string of this pathname's parent, or an empty string if this pathname does not name a parent directory.
Examples:
testIoTools.cpp, tutorial-detection-object-mbt.cpp, tutorial-mb-edge-tracker.cpp, tutorial-mb-hybrid-tracker.cpp, and tutorial-mb-klt-tracker.cpp.

Definition at line 1220 of file vpIoTools.cpp.

References path(), and separator.

Referenced by vpMbTracker::loadCAOModel(), vpKeyPoint::loadLearningData(), and vpKeyPoint::saveLearningData().

void vpIoTools::getUserName ( std::string &  username)
static

Get the user name.

  • Under unix, get the content of the LOGNAME environment variable. For most purposes (especially in conjunction with crontab), it is more useful to use the environment variable LOGNAME to find out who the user is, rather than the getlogin() function. This is more flexible precisely because the user can set LOGNAME arbitrarily.
  • Under windows, uses the GetUserName() function.
Parameters
username: The user name.
Exceptions
vpIoException::cantGetUserName: If this method cannot get the user name.
See also
getUserName()

Definition at line 94 of file vpIoTools.cpp.

References vpIoException::cantGetUserName, getenv(), and vpERROR_TRACE.

std::string vpIoTools::getUserName ( )
static

Get the user name.

  • Under unix, get the content of the LOGNAME environment variable. For most purposes (especially in conjunction with crontab), it is more useful to use the environment variable LOGNAME to find out who the user is, rather than the getlogin() function. This is more flexible precisely because the user can set LOGNAME arbitrarily.
  • Under windows, uses the GetUserName() function.
Returns
The user name.
Exceptions
vpIoException::cantGetUserName: If this method cannot get the user name.
See also
getUserName(std::string &)
Examples:
displayD3D.cpp, displayGTK.cpp, displayOpenCV.cpp, displayX.cpp, displayXMulti.cpp, histogram.cpp, imageDiskRW.cpp, servoAfma4Point2DArtVelocity.cpp, servoAfma4Point2DCamVelocity.cpp, servoAfma4Point2DCamVelocityKalman.cpp, servoAfma6FourPoints2DArtVelocity.cpp, servoAfma6FourPoints2DCamVelocityInteractionCurrent.cpp, servoAfma6FourPoints2DCamVelocityInteractionDesired.cpp, servoAfma6Point2DArtVelocity.cpp, servoAfma6Point2DCamVelocity.cpp, servoAfma6Segment2DCamVelocity.cpp, servoBiclopsPoint2DArtVelocity.cpp, servoSimu3D_cdMc_CamVelocity.cpp, servoSimu3D_cdMc_CamVelocityWithoutVpServo.cpp, servoSimu3D_cMcd_CamVelocity.cpp, servoSimu3D_cMcd_CamVelocityWithoutVpServo.cpp, servoSimuFourPoints2DPolarCamVelocityDisplay.cpp, servoViper650FourPoints2DArtVelocityInteractionCurrent.cpp, servoViper650FourPoints2DCamVelocityInteractionCurrent.cpp, servoViper650Point2DCamVelocity.cpp, servoViper850FourPoints2DArtVelocityInteractionCurrent.cpp, servoViper850FourPoints2DArtVelocityInteractionDesired.cpp, servoViper850FourPoints2DCamVelocityInteractionCurrent.cpp, servoViper850FourPointsKinect.cpp, servoViper850Point2DArtVelocity.cpp, servoViper850Point2DCamVelocity.cpp, servoViper850Point2DCamVelocityKalman.cpp, sonarPioneerReader.cpp, test1394TwoGrabber.cpp, testConversion.cpp, testCreateSubImage.cpp, testIoPGM.cpp, testIoPPM.cpp, testRobust.cpp, testUndistortImage.cpp, and testXmlParser.cpp.

Definition at line 141 of file vpIoTools.cpp.

References vpIoException::cantGetUserName, getenv(), and vpERROR_TRACE.

void vpIoTools::getVersion ( const std::string &  version,
unsigned int &  major,
unsigned int &  minor,
unsigned int &  patch 
)
static

Extract major, minor and patch from a version given as "x.x.x". Ex: If version is "1.2.1", major will be 1, minor 2 and patch 1.

Parameters
version: String to extract the values.
major: Extracted major.
minor: Extracted minor.
patch: Extracted patch.

Definition at line 268 of file vpIoTools.cpp.

std::string vpIoTools::getViSPImagesDataPath ( )
static

Get ViSP images data path. ViSP images data can be installed from Debian or Ubuntu visp-images-data package. It can be also installed from ViSP-images.zip that can be found on http://team.inria.fr/lagadic/visp/download.html page.

This function returns the path to the folder that contains the data.

  • It checks first if visp-images-data package is installed. In that case returns then /usr/share/visp-images-data".
  • Then it checks if VISP_INPUT_IMAGE_PATH environment variable that gives the location of the data is set. In that case returns the content of this environment var.

If the path is not found, returns an empty string.

Examples:
AROgre.cpp, AROgreBasic.cpp, displayD3D.cpp, displayGTK.cpp, displayOpenCV.cpp, displaySequence.cpp, displayX.cpp, displayXMulti.cpp, fernClassifier.cpp, grabDisk.cpp, histogram.cpp, imageDiskRW.cpp, imageSequenceReader.cpp, keyPointSurf.cpp, mbtEdgeKltTracking.cpp, mbtEdgeTracking.cpp, mbtKltTracking.cpp, photometricVisualServoing.cpp, planarObjectDetector.cpp, poseVirtualVS.cpp, servoSimu4Points.cpp, simulateCircle2DCamVelocity.cpp, simulateFourPoints2DCartesianCamVelocity.cpp, simulateFourPoints2DPolarCamVelocity.cpp, templateTracker.cpp, testClick.cpp, testConversion.cpp, testCreateSubImage.cpp, testIoPGM.cpp, testIoPPM.cpp, testMouseEvent.cpp, testReadImage.cpp, testSurfKeyPoint.cpp, testTrackDot.cpp, testUndistortImage.cpp, testVideoDevice.cpp, trackDot.cpp, trackDot2.cpp, trackDot2WithAutoDetection.cpp, trackKltOpencv.cpp, trackMeCircle.cpp, trackMeEllipse.cpp, trackMeLine.cpp, trackMeNurbs.cpp, and videoReader.cpp.

Definition at line 1071 of file vpIoTools.cpp.

References checkFilename(), and getenv().

bool vpIoTools::isAbsolutePathname ( const std::string &  pathname)
static

Return whether a path is absolute.

Returns
true if the pathname is absolute, false otherwise.
Examples:
testIoTools.cpp.

Definition at line 1291 of file vpIoTools.cpp.

References path(), and splitDrive().

Referenced by vpMbTracker::loadCAOModel(), and vpKeyPoint::loadLearningData().

bool vpIoTools::loadConfigFile ( const std::string &  confFile)
static

Reads the configuration file and parses it.

Parameters
confFile: path to the file containing the configuration parameters to parse.
Returns
true if succeed, false otherwise.

Definition at line 740 of file vpIoTools.cpp.

References configFile, configValues, configVars, vpMath::minimum(), and path().

void vpIoTools::makeDirectory ( const char *  dirname)
static

Create a new directory.

Parameters
dirname: Directory to create. The directory name is converted to the current system's format; see path().
Exceptions
vpIoException::invalidDirectoryName: The dirname is invalid.
vpIoException::cantCreateDirectory: If the directory cannot be created.
See also
makeDirectory(const std::string &)
Examples:
displayD3D.cpp, displayGTK.cpp, displayOpenCV.cpp, displayX.cpp, displayXMulti.cpp, histogram.cpp, imageDiskRW.cpp, servoAfma4Point2DArtVelocity.cpp, servoAfma4Point2DCamVelocity.cpp, servoAfma4Point2DCamVelocityKalman.cpp, servoAfma6FourPoints2DArtVelocity.cpp, servoAfma6FourPoints2DCamVelocityInteractionCurrent.cpp, servoAfma6FourPoints2DCamVelocityInteractionDesired.cpp, servoAfma6Point2DArtVelocity.cpp, servoAfma6Point2DCamVelocity.cpp, servoAfma6Segment2DCamVelocity.cpp, servoBiclopsPoint2DArtVelocity.cpp, servoSimu3D_cdMc_CamVelocity.cpp, servoSimu3D_cdMc_CamVelocityWithoutVpServo.cpp, servoSimu3D_cMcd_CamVelocity.cpp, servoSimu3D_cMcd_CamVelocityWithoutVpServo.cpp, servoSimuFourPoints2DPolarCamVelocityDisplay.cpp, servoViper650FourPoints2DArtVelocityInteractionCurrent.cpp, servoViper650FourPoints2DCamVelocityInteractionCurrent.cpp, servoViper650Point2DCamVelocity.cpp, servoViper850FourPoints2DArtVelocityInteractionCurrent.cpp, servoViper850FourPoints2DArtVelocityInteractionDesired.cpp, servoViper850FourPoints2DCamVelocityInteractionCurrent.cpp, servoViper850FourPointsKinect.cpp, servoViper850Point2DArtVelocity.cpp, servoViper850Point2DCamVelocity.cpp, servoViper850Point2DCamVelocityKalman.cpp, SickLDMRS-Process.cpp, sonarPioneerReader.cpp, test1394TwoGrabber.cpp, testConversion.cpp, testCreateSubImage.cpp, testIoPGM.cpp, testIoPPM.cpp, testRobust.cpp, testUndistortImage.cpp, and testXmlParser.cpp.

Definition at line 384 of file vpIoTools.cpp.

References vpIoException::cantCreateDirectory, checkDirectory(), vpIoException::invalidDirectoryName, path(), vpDEBUG_TRACE, and vpERROR_TRACE.

Referenced by createBaseNamePath(), makeDirectory(), vpServoData::open(), and vpKeyPoint::saveLearningData().

void vpIoTools::makeDirectory ( const std::string &  dirname)
static

Create a new directory.

Parameters
dirname: Directory to create. The directory name is converted to the current system's format; see path().
Exceptions
vpIoException::cantCreateDirectory: If the directory cannot be created.
See also
makeDirectory(const char *)

Definition at line 439 of file vpIoTools.cpp.

References vpIoException::cantCreateDirectory, makeDirectory(), and vpERROR_TRACE.

std::string vpIoTools::path ( const char *  pathname)
static

Converts a path name to the current system's format.

Parameters
pathname: Path name to convert. Path name to convert. Under windows, converts all the "/" characters in the pathname string into "\\" characters. Under Unix systems converts all the "\\" characters in the pathname string into "/" characters.
Returns
The converted path name.
See also
path(const std::string &)
Examples:
histogram.cpp, testIoTools.cpp, testUndistortImage.cpp, and testXmlParser.cpp.

Definition at line 695 of file vpIoTools.cpp.

Referenced by checkDirectory(), checkFilename(), copy(), createFilePath(), getName(), getParent(), isAbsolutePathname(), loadConfigFile(), makeDirectory(), path(), and remove().

std::string vpIoTools::path ( const std::string &  pathname)
static

Converts a path name to the current system's format.

Parameters
pathname: Path name to convert. Under windows, converts all the "/" characters in the pathname string into "\\" characters. Under Unix systems converts all the "\\" characters in the pathname string into "/" characters.
Returns
The converted path name.
See also
path(const char *)

Definition at line 727 of file vpIoTools.cpp.

References path().

bool vpIoTools::readConfigVar ( const std::string &  var,
float &  value 
)
static

Tries to read the parameter named var as a float.

Parameters
var: Name of the parameter in the configuration file.
value: Value to be read.
Returns
true if the parameter could be read.

Definition at line 791 of file vpIoTools.cpp.

References configValues, and configVars.

Referenced by readConfigVar().

bool vpIoTools::readConfigVar ( const std::string &  var,
double &  value 
)
static

Tries to read the parameter named var as a double.

Parameters
var: Name of the parameter in the configuration file.
value: Value to be read.
Returns
true if the parameter could be read.

Definition at line 821 of file vpIoTools.cpp.

References configValues, and configVars.

bool vpIoTools::readConfigVar ( const std::string &  var,
int &  value 
)
static

Tries to read the parameter named var as a int.

Parameters
var: Name of the parameter in the configuration file.
value: Value to be read.
Returns
true if the parameter could be read.

Definition at line 852 of file vpIoTools.cpp.

References configValues, and configVars.

bool vpIoTools::readConfigVar ( const std::string &  var,
unsigned int &  value 
)
static

Tries to read the parameter named var as a unsigned int.

Parameters
var: Name of the parameter in the configuration file.
value: Value to be read.
Returns
true if the parameter could be read.

Definition at line 876 of file vpIoTools.cpp.

References readConfigVar().

bool vpIoTools::readConfigVar ( const std::string &  var,
bool &  value 
)
static

Tries to read the parameter named var as a bool.

Parameters
var: Name of the parameter in the configuration file.
value: Value to be read.
Returns
true if the parameter could be read.

Definition at line 892 of file vpIoTools.cpp.

References readConfigVar().

bool vpIoTools::readConfigVar ( const std::string &  var,
std::string &  value 
)
static

Tries to read the parameter named var as a std::string.

Parameters
var: Name of the parameter in the configuration file.
value: Value to be read.
Returns
true if the parameter could be read.

Definition at line 924 of file vpIoTools.cpp.

References configValues, and configVars.

bool vpIoTools::readConfigVar ( const std::string &  var,
vpColor value 
)
static

Tries to read the parameter named var as a vpColor.

Parameters
var: Name of the parameter in the configuration file.
value: Value to be read. See vpColor.cpp for the color number.
Returns
true if the parameter could be read.

Definition at line 908 of file vpIoTools.cpp.

References vpColor::getColor(), and readConfigVar().

bool vpIoTools::readConfigVar ( const std::string &  var,
vpMatrix value,
const unsigned int &  nCols = 0,
const unsigned int &  nRows = 0 
)
static

Tries to read the parameter named var as a vpMatrix. If nCols and nRows are indicated, will resize the matrix. Otherwise, will try to read as many values as indicated by the dimension of value.

Parameters
var: Name of the parameter in the configuration file.
value: Value to be read.
nCols: Column dimension if resized.
nRows: Row dimension if resized
Returns
true if the parameter could be read.

Definition at line 952 of file vpIoTools.cpp.

References configValues, configVars, vpMatrix::getCols(), vpMatrix::getRows(), and vpMatrix::resize().

bool vpIoTools::remove ( const char *  file_or_dir)
static

Remove a file or a directory.

Parameters
file_or_dir: File or directory to remove.
Returns
true if the file or the directory was removed, false otherwise.
See also
remove(const std::string &)

Definition at line 597 of file vpIoTools.cpp.

References checkDirectory(), checkFilename(), and path().

Referenced by createBaseNamePath(), and remove().

bool vpIoTools::remove ( const std::string &  file_or_dir)
static

Remove a file or a directory.

Parameters
file_or_dir: File or directory to remove.
Returns
true if the file or the directory was removed, false otherwise.
See also
remove(const char *)

Definition at line 638 of file vpIoTools.cpp.

References remove().

bool vpIoTools::rename ( const char *  oldfilename,
const char *  newfilename 
)
static

Rename an existing file oldfilename in newfilename.

Parameters
oldfilename: File to rename.
newfilename: New file name.
Returns
true if the file was renamed, false otherwise.
See also
rename(const std::string &, const std::string &)

Definition at line 655 of file vpIoTools.cpp.

Referenced by rename().

bool vpIoTools::rename ( const std::string &  oldfilename,
const std::string &  newfilename 
)
static

Rename an existing file oldfilename in newfilename.

Parameters
oldfilename: File to rename.
newfilename: New file name.
Returns
true if the file was renamed, false otherwise.
See also
rename(const char *, const char *)

Definition at line 675 of file vpIoTools.cpp.

References rename().

void vpIoTools::saveConfigFile ( const bool &  actuallySave = true)
static

Copy the initial configuration file to the experiment directory.

Parameters
actuallySave: If false, do not copy the file.

Definition at line 1051 of file vpIoTools.cpp.

References baseDir, baseName, configFile, and copy().

static void vpIoTools::setBaseDir ( const std::string &  dir)
inlinestatic

Sets the base directory of the experiment files.

Parameters
dir: Directory where the data will be saved.

Definition at line 224 of file vpIoTools.h.

static void vpIoTools::setBaseName ( const std::string &  s)
inlinestatic

Sets the base name (prefix) of the experiment files.

Parameters
s: Prefix of the experiment files.

Definition at line 218 of file vpIoTools.h.

std::pair< std::string, std::string > vpIoTools::splitDrive ( const std::string &  pathname)
static

Split a path in a drive specification (a drive letter followed by a colon) and the path specification. It is always true that drivespec + pathspec == p Inspired by the Python 2.7.8 module.

Returns
a pair whose the first element is the drive specification and the second element the path specification
Examples:
testIoTools.cpp.

Definition at line 1315 of file vpIoTools.cpp.

Referenced by isAbsolutePathname().

Member Data Documentation

std::string vpIoTools::baseDir = ""
staticprotected

Definition at line 248 of file vpIoTools.h.

Referenced by createBaseNamePath(), and saveConfigFile().

std::string vpIoTools::baseName = ""
staticprotected

Definition at line 247 of file vpIoTools.h.

Referenced by addNameElement(), createBaseNamePath(), and saveConfigFile().

std::string vpIoTools::configFile = ""
staticprotected

Definition at line 249 of file vpIoTools.h.

Referenced by loadConfigFile(), and saveConfigFile().

std::vector< std::string > vpIoTools::configValues = std::vector<std::string>()
staticprotected

Definition at line 251 of file vpIoTools.h.

Referenced by loadConfigFile(), and readConfigVar().

std::vector< std::string > vpIoTools::configVars = std::vector<std::string>()
staticprotected

Definition at line 250 of file vpIoTools.h.

Referenced by loadConfigFile(), and readConfigVar().

const char vpIoTools::separator
static
Initial value:
=
'/'

Define the directory separator character, backslash ('\') for windows platform or slash ('/') otherwise.

Examples:
testIoTools.cpp.

Definition at line 184 of file vpIoTools.h.

Referenced by createFilePath(), getName(), and getParent().