File path of an ODM or raster dataset. See OPALS Datamanager and Supported grid/raster formats. More...
#include "OdmOrRasterFile.hpp"
Public Member Functions | |
OdmOrRasterFile (const Path &) | |
OdmOrRasterFile (const OdmOrRasterFile &) | |
Path () | |
Path (const char *) | |
Path (const String &) | |
Path (String &&) | |
Path (const Path &) | |
Path (Path &&) | |
Public Member Functions inherited from Path | |
Path (const char *) | |
Path (const String &) | |
Path (String &&) | |
Path (const Path &) | |
Path (Path &&) | |
void | clear () |
postcondition: this->empty() is true. | |
Path & | make_absolute () |
postcondition: For the returned path, is_absolute() is true. | |
Path & | make_preferred () |
Convert the contained pathname to the native format. | |
Path & | remove_filename () |
if has_parent_path() then remove the last filename from the stored path. | |
Path & | replace_extension (const String &new_extension=String()) |
postcondition: extension() == new_extension (where a leading dot has been removed from replacement, if present) | |
void | swap (Path &) |
swaps the contents of the two paths. | |
String | string () const |
returns the stored path, formatted according to the operating system rules for regular file pathnames | |
Path | root_name () const |
returns the root name (e.g. d:/path/filename.ext -> d:) | |
Path | root_directory () const |
returns the root directory (e.g. d:/path/filename.ext -> /) | |
Path | root_path () const |
returns root_name() + root_directory() | |
Path | relative_path () const |
returns the stored path without root_path() (e.g. d:/path/file.ext -> path/file.ext) | |
Path | parent_path () const |
returns the parent directory, if any (e.g. d:/path/filename.ext -> d:/path/) | |
Path | filename () const |
returns the filename (i.e. /path/filename.ext -> filename.ext) | |
String | stem () const |
returns the filename without extension (i.e. /path/filename.ext -> filename) | |
String | extension () const |
returns the filename extension (i.e. /path/filename.ext -> .ext) | |
bool | empty () const |
returns string().empty() | |
bool | has_root_name () const |
returns !root_name().empty() | |
bool | has_root_directory () const |
returns !root_directory().empty() | |
bool | has_root_path () const |
returns !root_path().empty() | |
bool | has_relative_path () const |
returns !relative_path().empty() | |
bool | has_parent_path () const |
returns !parent_path().empty() | |
bool | has_filename () const |
returns !filename().empty() | |
bool | has_stem () const |
returns !stem().empty() | |
bool | has_extension () const |
returns !extension().empty() | |
bool | is_absolute () const |
returns true if the elements of root_path() uniquely identify a directory, else false | |
bool | is_relative () const |
returns !is_absolute() | |
Path & | normalize () |
Replace symlinks, replace '/' with '\', replace "foo/../bar" with "bar", etc. | |
String | compressed (size_type length) const |
shorten path to length, e.g. d:/foo_long_directory_name/bar.txt -> d:/foo.../bar.txt | |
Path & | operator= (const char *) |
Path & | operator= (const String &) |
Path & | operator= (String &&) |
Path & | operator= (const Path &) |
Path & | operator= (Path &&) |
Path & | operator/= (const char *) |
Path & | operator/= (const String &) |
Path & | operator/= (const Path &) |
Path | operator+ (const char *) const |
Path | operator+ (const String &) const |
Path | operator+ (const Path &) const |
Path & | operator+= (const char *) |
Path & | operator+= (const String &) |
Path & | operator+= (const Path &) |
Static Public Member Functions | |
static bool | exportsPythonType () |
static const char * | help (bool) |
static const char * | syntax () |
Static Public Member Functions inherited from CustomOptionType< OdmOrRasterFile > | |
static const char * | _help (bool forDoxygen) |
get general help on this type | |
static const char * | _syntax () |
get the syntax used for parsing this type | |
static bool | _exportsPythonType () |
returns true if this type is exposed to Python as a custom type, false otherwise (if it is represented as Python-string) | |
Additional Inherited Members | |
Public Types inherited from Path | |
using | size_type = String::size_type |
Protected Member Functions inherited from CustomOptionType< OdmOrRasterFile > | |
~CustomOptionType () | |
protected, must be derived from | |
Related Functions inherited from Path | |
void | swap (Path &, Path &) |
Path | operator/ (const Path &lhs, const Path &rhs) |
Path | operator/ (const Path &lhs, const char *rhs) |
Path | operator/ (const char *lhs, const Path &rhs) |
Path | operator/ (const Path &lhs, const String &rhs) |
Path | operator/ (const String &lhs, const Path &rhs) |
bool | operator< (const Path &, const Path &) |
bool | operator<= (const Path &, const Path &) |
bool | operator> (const Path &, const Path &) |
bool | operator>= (const Path &, const Path &) |
bool | operator== (const Path &, const Path &) |
bool | operator== (const Path &, const String &) |
bool | operator== (const String &, const Path &) |
bool | operator== (const Path &, const char *) |
bool | operator== (const char *, const Path &) |
bool | operator!= (const Path &, const Path &) |
bool | operator!= (const Path &, const String &) |
bool | operator!= (const String &, const Path &) |
bool | operator!= (const Path &, const char *) |
bool | operator!= (const char *, const Path &) |
std::size_t | hash_value (const Path &p) |
File path of an ODM or raster dataset. See OPALS Datamanager and Supported grid/raster formats.