torc::common::DirectoryTree Class Reference

Encapsulation of filesystem paths that are used by the library. More...

#include <DirectoryTree.hpp>

List of all members.

Public Member Functions
	DirectoryTree (const char *argv0)
	Mandatory constructor.
Static Public Member Functions
static const boost::filesystem::path &	getRelativePath (void)
	Returns the relative path from the working directory to the executable home.
static const boost::filesystem::path &	getWorkingPath (void)
	Returns the absolute path to the working directory.
static const boost::filesystem::path &	getExecutablePath (void)
	Returns the absolute path to the executable directory.
static const boost::filesystem::path &	getDevicesPath (void)
	Returns the absolute path to the family and device database directory.
static const boost::filesystem::path &	getLogPath (void)
	Returns the absolute path to the log files directory.
Static Protected Attributes
static boost::filesystem::path	sRelativePath
	Relative path from the working directory to the executable home.
static boost::filesystem::path	sWorkingPath
	Absolute path to the working directory.
static boost::filesystem::path	sExecutablePath
	Absolute path to the executable directory.
static boost::filesystem::path	sEdaPath
	Absolute path to the EDA libraries directory.
static boost::filesystem::path	sDevicesPath
	Absolute path to the family and device database directory.
static boost::filesystem::path	sLogPath
	Absolute path to the log files directory.

---

Detailed Description

Encapsulation of filesystem paths that are used by the library.

Definition at line 28 of file DirectoryTree.hpp.

---

Constructor & Destructor Documentation

torc::common::DirectoryTree::DirectoryTree

(

const char *

argv0

)

Mandatory constructor.

Parameters:

argv0

The zero-th argument passed to main in argv[]. DirectoryTree needs this to derive the relative path from the working directory to the executable, until such a time as Boost provides a better approach. Extracts the zero-th argument, and builds the various static paths used by the executable.

Definition at line 40 of file DirectoryTree.cpp.

---

Member Function Documentation

static const boost::filesystem::path& torc::common::DirectoryTree::getRelativePath

(

void

)

[inline, static]

Returns the relative path from the working directory to the executable home.

Definition at line 54 of file DirectoryTree.hpp.

static const boost::filesystem::path& torc::common::DirectoryTree::getWorkingPath

(

void

)

[inline, static]

Returns the absolute path to the working directory.

Definition at line 56 of file DirectoryTree.hpp.

static const boost::filesystem::path& torc::common::DirectoryTree::getExecutablePath

(

void

)

[inline, static]

Returns the absolute path to the executable directory.

Definition at line 58 of file DirectoryTree.hpp.

static const boost::filesystem::path& torc::common::DirectoryTree::getDevicesPath

(

void

)

[inline, static]

Returns the absolute path to the family and device database directory.

Definition at line 60 of file DirectoryTree.hpp.

static const boost::filesystem::path& torc::common::DirectoryTree::getLogPath

(

void

)

[inline, static]

Returns the absolute path to the log files directory.

Definition at line 62 of file DirectoryTree.hpp.

---

Member Data Documentation

boost::filesystem::path torc::common::DirectoryTree::sRelativePath [static, protected]

Relative path from the working directory to the executable home.

Definition at line 32 of file DirectoryTree.hpp.

boost::filesystem::path torc::common::DirectoryTree::sWorkingPath [static, protected]

Absolute path to the working directory.

Definition at line 34 of file DirectoryTree.hpp.

boost::filesystem::path torc::common::DirectoryTree::sExecutablePath [static, protected]

Absolute path to the executable directory.

Definition at line 36 of file DirectoryTree.hpp.

boost::filesystem::path torc::common::DirectoryTree::sEdaPath [static, protected]

Absolute path to the EDA libraries directory.

Definition at line 38 of file DirectoryTree.hpp.

boost::filesystem::path torc::common::DirectoryTree::sDevicesPath [static, protected]

Absolute path to the family and device database directory.

Definition at line 40 of file DirectoryTree.hpp.

boost::filesystem::path torc::common::DirectoryTree::sLogPath [static, protected]

Absolute path to the log files directory.

Definition at line 42 of file DirectoryTree.hpp.

---

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

• torc/common/DirectoryTree.hpp
• torc/common/DirectoryTree.cpp