Path name class supporting Windows and UN*X/Linux format names. More...

#include <PathName.hh>

Public Member Functions
	PathName ()
	Default constructor. More...

	PathName (std::string const &name_string)
	String constructor. More...

	~PathName ()=default
	Destructor. More...

PathName &	operator= (std::string const &name_string)
	String assignment. More...

	operator std::string () const
	String conversion. More...

PathName &	operator() (PathName const &name)
	Functor copy assignment. More...

PathName &	operator() (std::string const &name_string)
	Functor string assignment. More...

PathName &	vol (std::string const &vol_a)
	Volume assignment. More...

PathName &	volume (std::string const &vol_a)
	Volume assignment. More...

PathName &	path (std::string const &path_a)
	Path assignment. More...

PathName &	erase ()
	Erase the path name. More...

PathName &	clear ()
	Clear the path name. More...

PathName	parent () const
	Returns the parent of this directory, or itself if no parent is available. More...

bool	empty () const
	Empty? More...

bool	absolute () const
	Absolute path? More...

bool	relative () const
	Relative path? More...

std::string const &	vol () const
	Volume. More...

std::string const &	volume () const
	Volume. More...

std::string const &	path () const
	Path. More...

std::string	name () const
	Path name string. More...

std::string	operator() () const
	Functor. More...

Private Member Functions
void	assign (std::string const &name_string)
	Parse and assign a path name string. More...

Static Private Member Functions
static bool	equal (PathName const &name1, PathName const &name2)
	PathNames equal on this platform? More...

Private Attributes
std::string	vol_
	Volume (X:) (Windows only) More...

std::string	path_
	Path (with trailing separator) More...

Friends
bool	operator== (PathName const &name1, PathName const &name2)
	PathName == PathName. More...

bool	operator!= (PathName const &name1, PathName const &name2)
	PathName != PathName. More...

bool	operator< (PathName const &name1, PathName const &name2)
	PathName < PathName. More...

bool	operator<= (PathName const &name1, PathName const &name2)
	PathName <= PathName. More...

bool	operator>= (PathName const &name1, PathName const &name2)
	PathName >= PathName. More...

bool	operator> (PathName const &name1, PathName const &name2)
	PathName > PathName. More...

std::istream &	operator>> (std::istream &stream, PathName &name)
	Input from stream. More...

std::ostream &	operator<< (std::ostream &stream, PathName const &name)
	Output to stream. More...

Detailed Description

Path name class supporting Windows and UN*X/Linux format names.

Constructor & Destructor Documentation

◆ PathName() [1/2]

utility::file::PathName::PathName ( )

inline

Default constructor.

◆ PathName() [2/2]

utility::file::PathName::PathName ( std::string const & name_string )

inline

String constructor.

References assign().

◆ ~PathName()

utility::file::PathName::~PathName ( )

inlinedefault

Destructor.

Member Function Documentation

◆ absolute()

bool utility::file::PathName::absolute ( ) const

Absolute path?

References path_, and platform::file::PATH_SEPARATOR().

Referenced by relative().

◆ assign()

void utility::file::PathName::assign ( std::string const & name_string )

private

Parse and assign a path name string.

References path_, platform::file::PATH_SEPARATOR(), binder::replace(), vol_, and platform::file::VOLUME_USED().

Referenced by operator()(), operator=(), and PathName().

◆ clear()

PathName& utility::file::PathName::clear ( )

inline

Clear the path name.

References path_, and vol_.

Referenced by pyrosetta.bindings.pose.ResidueLabelAccessor::discard().

◆ empty()

bool utility::file::PathName::empty ( ) const

inline

Empty?

References path_, and vol_.

◆ equal()

bool utility::file::PathName::equal	(	PathName const &	name1,
		PathName const &	name2
	)

staticprivate

PathNames equal on this platform?

References platform::file::CASE_SENSITIVE(), utility::file::equali(), path_, and vol_.

◆ erase()

PathName& utility::file::PathName::erase ( )

inline

Erase the path name.

References path_, and vol_.

◆ name()

std::string utility::file::PathName::name ( ) const

inline

Path name string.

References path_, and vol_.

Referenced by pyrosetta.distributed.docs.ComponentDoc::__repr__(), utility::file::create_directory_recursive(), options_class.Option::getCName(), options_class.Option::getDoxygenRow(), options_class.Option::getMarkdownRow(), options_class.Option::getOptionKeysCC(), options_class.Option::getWikiTableRow(), operator std::string(), operator()(), parent(), enumerate_junctions.DHR::print(), enumerate_junctions.DHR::to_component(), and enumerate_junctions.DHR::write_to_file().

◆ operator std::string()

utility::file::PathName::operator std::string ( ) const

inline

String conversion.

References name().

◆ operator()() [1/3]

std::string utility::file::PathName::operator() ( ) const

inline

Functor.

References name().

◆ operator()() [2/3]

PathName& utility::file::PathName::operator() ( PathName const & name )

inline

Functor copy assignment.

References name(), and operator=().

◆ operator()() [3/3]

PathName& utility::file::PathName::operator() ( std::string const & name_string )

inline

Functor string assignment.

References assign().

◆ operator=()

PathName& utility::file::PathName::operator= ( std::string const & name_string )

inline

String assignment.

References assign().

Referenced by operator()().

◆ parent()

PathName utility::file::PathName::parent ( ) const

Returns the parent of this directory, or itself if no parent is available.

For relative paths, this will stop when it reaches the empty string – no "../" will be prepended to possibly go further up the directory tree.

References name(), path(), path_, and platform::file::PATH_SEPARATOR().

Referenced by utility::file::create_directory_recursive().

◆ path() [1/2]

std::string const& utility::file::PathName::path ( ) const

inline

Path.

References path_.

Referenced by arls_impl.DockingFile::__cmp__(), arls_impl.DockingFile::__hash__(), arls_impl.DockingFile::__repr__(), and arls_impl.DockingFile::__str__().

◆ path() [2/2]

PathName & utility::file::PathName::path ( std::string const & path_a )

Path assignment.

References path_, platform::file::PATH_SEPARATOR(), and binder::replace().

Referenced by arls_impl.DockingFile::__cmp__(), arls_impl.DockingFile::__hash__(), arls_impl.DockingFile::__repr__(), arls_impl.DockingFile::__str__(), utility::file::FileName::FileName(), and parent().

◆ relative()

bool utility::file::PathName::relative ( ) const

Relative path?

References absolute().

◆ vol() [1/2]

std::string const& utility::file::PathName::vol ( ) const

inline

Volume.

References vol_.

Referenced by volume().

◆ vol() [2/2]

PathName & utility::file::PathName::vol ( std::string const & vol_a )

Volume assignment.

References runtime_assert, vol_, and platform::file::VOLUME_USED().

Referenced by utility::file::FileName::FileName().

◆ volume() [1/2]

std::string const& utility::file::PathName::volume ( ) const

inline

Volume.

References vol_.

◆ volume() [2/2]

PathName& utility::file::PathName::volume ( std::string const & vol_a )

inline

Volume assignment.

References vol().

Friends And Related Function Documentation

◆ operator!=

bool operator!=	(	PathName const &	name1,
		PathName const &	name2
	)

friend

PathName != PathName.

◆ operator<

bool operator<	(	PathName const &	name1,
		PathName const &	name2
	)

friend

PathName < PathName.

◆ operator<<

std::ostream& operator<<	(	std::ostream &	stream,
		PathName const &	name
	)

friend

Output to stream.

◆ operator<=

bool operator<=	(	PathName const &	name1,
		PathName const &	name2
	)

friend

PathName <= PathName.

◆ operator==

bool operator==	(	PathName const &	name1,
		PathName const &	name2
	)

friend

PathName == PathName.

◆ operator>

bool operator>	(	PathName const &	name1,
		PathName const &	name2
	)

friend

PathName > PathName.

◆ operator>=

bool operator>=	(	PathName const &	name1,
		PathName const &	name2
	)

friend

PathName >= PathName.

◆ operator>>

std::istream& operator>>	(	std::istream &	stream,
		PathName &	name
	)

friend

Input from stream.

Member Data Documentation

◆ path_

std::string utility::file::PathName::path_

private

Path (with trailing separator)

Referenced by absolute(), assign(), clear(), empty(), equal(), erase(), name(), parent(), and path().

◆ vol_

std::string utility::file::PathName::vol_

private

Volume (X:) (Windows only)

Referenced by assign(), clear(), empty(), equal(), erase(), name(), vol(), and volume().

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

src/utility/file/PathName.hh
src/utility/file/PathName.cc

Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ PathName() [1/2]

◆ PathName() [2/2]

◆ ~PathName()

Member Function Documentation

◆ absolute()

◆ assign()

◆ clear()

◆ empty()

◆ equal()

◆ erase()

◆ name()

◆ operator std::string()

◆ operator()() [1/3]

◆ operator()() [2/3]

◆ operator()() [3/3]

◆ operator=()

◆ parent()

◆ path() [1/2]

◆ path() [2/2]

◆ relative()

◆ vol() [1/2]

◆ vol() [2/2]

◆ volume() [1/2]

◆ volume() [2/2]

Friends And Related Function Documentation

◆ operator!=

◆ operator<

◆ operator<<

◆ operator<=

◆ operator==

◆ operator>

◆ operator>=

◆ operator>>

Member Data Documentation

◆ path_

◆ vol_