NS-3
ns3::SystemPath Namespace Reference

Encapsulate OS-specific functions to manipulate file and directory paths. More...

Functions

std::string FindSelfDirectory (void)
std::string Append (std::string left, std::string right)
std::list< std::string > Split (std::string path)
std::string Join (std::list< std::string >::const_iterator begin, std::list< std::string >::const_iterator end)
std::list< std::string > ReadFiles (std::string path)
std::string MakeTemporaryDirectoryName (void)
void MakeDirectories (std::string path)

Detailed Description

Encapsulate OS-specific functions to manipulate file and directory paths.

The functions provided here are used mostly to implement the ns-3 test framework.


Function Documentation

std::string ns3::SystemPath::Append ( std::string  left,
std::string  right 
)
Parameters:
lefta path element
righta path element
Returns:
a concatenation of the two input paths
std::string ns3::SystemPath::FindSelfDirectory ( void  )
Returns:
the directory in which the currently-executing binary is located
std::string ns3::SystemPath::Join ( std::list< std::string >::const_iterator  begin,
std::list< std::string >::const_iterator  end 
)
Parameters:
beginiterator to first element to join
enditerator to last element to join
Returns:
a path that is a concatenation of all the input elements.
void ns3::SystemPath::MakeDirectories ( std::string  path)
Parameters:
patha path to a directory

Create all the directories leading to path.

std::string ns3::SystemPath::MakeTemporaryDirectoryName ( void  )
Returns:
a path which identifies a temporary directory.

The returned path identifies a directory which does not exist yet Call ns3::SystemPath::MakeDirectories to create it. Yes, there is a well-known security race in this API but we don't care in ns-3.

std::list<std::string> ns3::SystemPath::ReadFiles ( std::string  path)
Parameters:
patha path which identifies a directory
Returns:
a list of the filenames which are located in the input directory
std::list<std::string> ns3::SystemPath::Split ( std::string  path)
Parameters:
patha path
Returns:
a list of path elements that can be joined together again with the Join function.
See also:
ns3::SystemPath::Join