geos::Path Class Reference

Class describing a file Path. More...

#include <Path.hpp>

Inheritance diagram for geos::Path:

Public Member Functions
	Path ()
	Default constructor.
	Path (Path const &rhs)
	Copy constructor. More...
	Path (Path &&rhs) noexcept
	Move constructor. More...
Path &	operator= (Path const &rhs)
	Copy assignment. More...
Path &	operator= (Path &&rhs) noexcept
	Move assignment. More...
	~Path ()
	Destructor.
std::string	filename () const
std::string	extension () const
std::string	relativeFilePath () const

Static Public Member Functions
static void	setPathPrefix (std::string_view p)
	Set the path prefix of the file. More...
static std::string_view	getPathPrefix ()
	Get the path prefix of the file. More...

Detailed Description

Class describing a file Path.

Purpose of this class is to be used as a type to specify file path within the XML input files, through the operator>>.

Definition at line 34 of file Path.hpp.

Constructor & Destructor Documentation

Path() [1/2]

geos::Path::Path ( Path const &  rhs )

inline

Copy constructor.

Parameters

rhs	Path to be copied.

Definition at line 50 of file Path.hpp.

Path() [2/2]

geos::Path::Path ( Path &&  rhs )

inlinenoexcept

Move constructor.

Parameters

rhs	Path to be moved.

Definition at line 57 of file Path.hpp.

Member Function Documentation

extension()

std::string geos::Path::extension

(

)

const

Returns

the extension of the filename

filename()

std::string geos::Path::filename

(

)

const

Returns

the filename portion of the path

getPathPrefix()

static std::string_view geos::Path::getPathPrefix ( )

inlinestatic

Get the path prefix of the file.

The path prefix is usually a folder path in which the XML file is located

Returns

the path prefix

Definition at line 101 of file Path.hpp.

operator=() [1/2]

Path& geos::Path::operator= ( Path &&  rhs )

inlinenoexcept

Move assignment.

Parameters

rhs	Path to be moved.

Returns

*this

Definition at line 76 of file Path.hpp.

operator=() [2/2]

Path& geos::Path::operator= ( Path const &  rhs )

inline

Copy assignment.

Parameters

rhs	Path to be copied.

Returns

*this

Definition at line 65 of file Path.hpp.

relativeFilePath()

std::string geos::Path::relativeFilePath

(

)

const

Returns

the complete path to the file, relative to getPathPrefix().

setPathPrefix()

static void geos::Path::setPathPrefix ( std::string_view  p )

inlinestatic

Set the path prefix of the file.

The path prefix is usually a folder path in which the XML file is located

Parameters

p	Path prefix to be set.

Definition at line 93 of file Path.hpp.

---

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

• coreComponents/common/Path.hpp