mars_lib  0.1.0.3dc76ee85e09
Modular and Robust Sensor-Fusion
Public Member Functions | Static Public Member Functions | List of all members
mars::filesystem Class Reference

The filesystem class implements a wrapper for file or directory interaction. More...

#include </home/runner/work/mars_lib/mars_lib/source/mars/include/mars/data_utils/filesystem.h>

+ Collaboration diagram for mars::filesystem:

Public Member Functions

 filesystem ()
 

Static Public Member Functions

static bool IsFile (const std::string &name)
 filesystem::IsFile Check if the given path results in a file More...
 
static bool IsDir (const std::string &name)
 filesystem::IsDir Check if the given path results in an directory More...
 
static bool MakeDir (const std::string &name)
 filesystem::MakeDir Create a directory if it does not exist More...
 

Detailed Description

The filesystem class implements a wrapper for file or directory interaction.

If needed, adaptations to a specific OS can be made here.

Constructor & Destructor Documentation

◆ filesystem()

mars::filesystem::filesystem ( )

Member Function Documentation

◆ IsFile()

static bool mars::filesystem::IsFile ( const std::string &  name)
static

filesystem::IsFile Check if the given path results in a file

Parameters
namestring containing the absolute file path
Returns
true if file, false if not a file
+ Here is the caller graph for this function:

◆ IsDir()

static bool mars::filesystem::IsDir ( const std::string &  name)
static

filesystem::IsDir Check if the given path results in an directory

Parameters
namestring containing the absolute directory path
Returns
true if directory, false if not a directory

◆ MakeDir()

static bool mars::filesystem::MakeDir ( const std::string &  name)
static

filesystem::MakeDir Create a directory if it does not exist

Parameters
namestring containing the absolute directory path
Returns
true if folder was created or already existed, false if it could not be created

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