apis/cpp/gamspath_8h_source.html

/*

 * GAMS - General Algebraic Modeling System C++ API

 *

 * Copyright (c) 2017-2024 GAMS Software GmbH <support@gams.com>

 * Copyright (c) 2017-2024 GAMS Development Corp. <support@gams.com>

 *

 * Permission is hereby granted, free of charge, to any person obtaining a copy

 * of this software and associated documentation files (the "Software"), to deal

 * in the Software without restriction, including without limitation the rights

 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

 * copies of the Software, and to permit persons to whom the Software is

 * furnished to do so, subject to the following conditions:

 *

 * The above copyright notice and this permission notice shall be included in all

 * copies or substantial portions of the Software.

 *

 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

 * SOFTWARE.

 */


#ifndef GAMSPATH_H

#define GAMSPATH_H


#include <filesystem>


namespace gams {


class GAMSPath : public std::filesystem::path

{

public:

    GAMSPath() : std::filesystem::path() {}


    GAMSPath(const char *file) : std::filesystem::path(file) {}


    GAMSPath(const std::string &file) : std::filesystem::path(file) {}


    GAMSPath(const std::filesystem::path &file) : std::filesystem::path(file) {}


    GAMSPath(const std::filesystem::path & dir, const std::string &file) : std::filesystem::path(dir / file){ }


    GAMSPath(const GAMSPath &gpath) : std::filesystem::path(gpath.string()) {}


    GAMSPath &operator=(const GAMSPath &other);


    GAMSPath &operator <<(const std::string &append);


    GAMSPath &operator +=(const std::string &append);


    GAMSPath operator +(const std::string &append);


    GAMSPath operator +(const char *append);


    GAMSPath operator /(const GAMSPath &append);


    GAMSPath operator /(const std::string &append);


    GAMSPath operator /(const char *append);


    operator std::string();


    std::string toStdString() const;


    const char* c_str() const;


    GAMSPath tempDir(const std::string &tempPath = std::string());


    GAMSPath tempFile(const std::string &tempName = "XXXXXX.tmp");


    void setSuffix(const char *suffix);


    void setSuffix(const std::string &suffix);


    GAMSPath suffix(const std::string &suffix) const;


    GAMSPath suffix(const char *suffix) const;


    GAMSPath up() const;


    std::string suffix() const;


    GAMSPath path() const;


    bool mkDir() const;


    bool rmDirRecurse();


    void pack();


    bool remove();


    bool rename(const std::string &newFileName);


    bool rename(const char *newFileName);


    bool exists() const;


    static bool exists(const std::string &file);


    static bool exists(const char *file);


};


#ifdef _WIN32

static thread_local bool seedGenerated;

#else

#pragma GCC diagnostic push

#pragma GCC diagnostic ignored "-Wunused-variable"

static thread_local bool seedGenerated;

#pragma GCC diagnostic pop

#endif


}


#endif // GPATH_H

gams::GAMSPath
Represents the GAMS path to a specific file.
Definition: gamspath.h:35

gams::GAMSPath::GAMSPath
GAMSPath(const GAMSPath &gpath)
Definition: gamspath.h:59

gams::GAMSPath::operator/
GAMSPath operator/(const GAMSPath &append)

gams::GAMSPath::rename
bool rename(const char *newFileName)

gams::GAMSPath::suffix
GAMSPath suffix(const std::string &suffix) const

gams::GAMSPath::GAMSPath
GAMSPath(const char *file)
Definition: gamspath.h:42

gams::GAMSPath::pack
void pack()
Normalizes the Path to make it comparable by converting it to it's shortest absolute representation.

gams::GAMSPath::tempDir
GAMSPath tempDir(const std::string &tempPath=std::string())

gams::GAMSPath::operator+=
GAMSPath & operator+=(const std::string &append)

gams::GAMSPath::setSuffix
void setSuffix(const char *suffix)

gams::GAMSPath::GAMSPath
GAMSPath(const std::filesystem::path &file)
Definition: gamspath.h:50

gams::GAMSPath::exists
bool exists() const

gams::GAMSPath::c_str
const char * c_str() const

gams::GAMSPath::operator+
GAMSPath operator+(const std::string &append)

gams::GAMSPath::suffix
std::string suffix() const
Path suffix.

gams::GAMSPath::GAMSPath
GAMSPath(const std::filesystem::path &dir, const std::string &file)
Definition: gamspath.h:55

gams::GAMSPath::rename
bool rename(const std::string &newFileName)

gams::GAMSPath::path
GAMSPath path() const
Get the GAMSPath.

gams::GAMSPath::GAMSPath
GAMSPath()
Standard constructor.
Definition: gamspath.h:38

gams::GAMSPath::GAMSPath
GAMSPath(const std::string &file)
Definition: gamspath.h:46

gams::GAMSPath::exists
static bool exists(const char *file)

gams::GAMSPath::operator<<
GAMSPath & operator<<(const std::string &append)

gams::GAMSPath::suffix
GAMSPath suffix(const char *suffix) const

gams::GAMSPath::mkDir
bool mkDir() const
Create the directory.

gams::GAMSPath::toStdString
std::string toStdString() const
Get the path or file as std::string.

gams::GAMSPath::operator=
GAMSPath & operator=(const GAMSPath &other)

gams::GAMSPath::remove
bool remove()

gams::GAMSPath::tempFile
GAMSPath tempFile(const std::string &tempName="XXXXXX.tmp")

gams::GAMSPath::string
operator std::string()
Converts a std::string to GAMSPath.

gams::GAMSPath::exists
static bool exists(const std::string &file)

gams::GAMSPath::rmDirRecurse
bool rmDirRecurse()

gams::GAMSPath::up
GAMSPath up() const

gams::GAMSPath::setSuffix
void setSuffix(const std::string &suffix)

gams
Definition: gams.h:91