GEOSX
Public Member Functions | Static Public Member Functions | List of all members
geosx::Path Class Reference

Class describing a file Path. More...

#include <Path.hpp>

Inheritance diagram for geosx::Path:
Inheritance graph
[legend]

Public Member Functions

 Path ()
 Default constructor.
 
 Path (Path const &src)
 Copy constructor, creates a copy of src. More...
 
 ~Path ()
 Destructor.
 
Pathoperator= (Path const &rhs)
 Copy Constructor. More...
 

Static Public Member Functions

static std::string & pathPrefix ()
 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 30 of file Path.hpp.

Constructor & Destructor Documentation

◆ Path()

geosx::Path::Path ( Path const &  src)
inline

Copy constructor, creates a copy of src.

Parameters
srcthe Path to copy.

Definition at line 43 of file Path.hpp.

Member Function Documentation

◆ operator=()

Path& geosx::Path::operator= ( Path const &  rhs)
inline

Copy Constructor.

Parameters
rhsReference to the Path that will be copied.
Returns
*this

Definition at line 56 of file Path.hpp.

◆ pathPrefix()

static std::string& geosx::Path::pathPrefix ( )
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 70 of file Path.hpp.


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