Fishnet 2.0.1
Framework for Graph-Based Analysis of GIS Vector Data
Loading...
Searching...
No Matches
fishnet::AbstractVectorFile Class Reference

#include <GISFile.hpp>

Inheritance diagram for fishnet::AbstractVectorFile:
Collaboration diagram for fishnet::AbstractVectorFile:

Public Member Functions

 AbstractVectorFile (const std::filesystem::path &pathToFile)
 
 AbstractVectorFile (const std::string &pathName)
 
virtual ~AbstractVectorFile ()=default
 
constexpr GISFileType type () const noexcept override
 Returns the type of GISFile.
 
bool remove () const noexcept override
 Removes the file from the filesystem.
 
AbstractVectorFile & move (const std::filesystem::path &newPath)
 
AbstractVectorFile copy (const std::filesystem::path &newPath) const
 
std::string toString () const noexcept
 
- Public Member Functions inherited from fishnet::AbstractGISFile
const std::filesystem::path & getPath () const noexcept
 
 operator bool () const noexcept
 
bool exists () const noexcept
 Tests if the GISFile exists on the filesystem.
 
bool supports (const std::filesystem::path &path) const noexcept
 Checks if the supplied path is supported by the concrete GISFile implementation.
 
void changeFilename (const std::string &filename) noexcept
 Modifies the path of the GISFile by changing the filename (extension is preserved).
 
void appendToFilename (const std::string &suffix) noexcept
 Appends a suffix to the filename / stem of the GISFile (extension is preserved).
 
virtual ~AbstractGISFile ()=default
 

Additional Inherited Members

- Protected Member Functions inherited from fishnet::AbstractGISFile
void supportsOrThrow (const std::filesystem::path &path) const
 
- Protected Attributes inherited from fishnet::AbstractGISFile
std::filesystem::path pathToFile
 

Constructor & Destructor Documentation

◆ AbstractVectorFile() [1/2]

fishnet::AbstractVectorFile::AbstractVectorFile ( const std::filesystem::path &  pathToFile)
inline

◆ AbstractVectorFile() [2/2]

fishnet::AbstractVectorFile::AbstractVectorFile ( const std::string &  pathName)
inline

◆ ~AbstractVectorFile()

virtual fishnet::AbstractVectorFile::~AbstractVectorFile ( )
virtualdefault

Member Function Documentation

◆ copy()

AbstractVectorFile fishnet::AbstractVectorFile::copy ( const std::filesystem::path &  newPath) const
inline

◆ move()

AbstractVectorFile & fishnet::AbstractVectorFile::move ( const std::filesystem::path &  newPath)
inline

◆ remove()

bool fishnet::AbstractVectorFile::remove ( ) const
inlineoverridevirtualnoexcept

Removes the file from the filesystem.

Returns
true success
false error

Implements fishnet::AbstractGISFile.

Reimplemented in fishnet::GeoPackage, and fishnet::Shapefile.

◆ toString()

std::string fishnet::AbstractVectorFile::toString ( ) const
inlinenoexcept

◆ type()

constexpr GISFileType fishnet::AbstractVectorFile::type ( ) const
inlineconstexproverridevirtualnoexcept

Returns the type of GISFile.

Returns
constexpr GISFileType

Implements fishnet::AbstractGISFile.

Reimplemented in fishnet::GeoPackage, and fishnet::Shapefile.


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