apis/cpp/gamsequation_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 GAMSEQUATION_H

#define GAMSEQUATION_H


#include "gamssymbol.h"

#include "gamsequationrecord.h"


namespace gams {


class LIBSPEC GAMSEquation : public GAMSSymbol

{

public:


    typedef GAMSEquationRecord RecordType;


    GAMSEquation() {}


    GAMSEquation(const GAMSSymbol &other);


    ~GAMSEquation();


    GAMSSymbolIter<GAMSEquation> begin();


    GAMSSymbolIter<GAMSEquation> end();


    GAMSEquation& operator=(const GAMSEquation& other);


    GAMSEquationRecord firstRecord(const std::vector<std::string>& slice);


    GAMSEquationRecord firstRecord();


    GAMSEquationRecord firstRecord(const std::string& key1);


    GAMSEquationRecord firstRecord(const std::string& key1, const std::string& key2);


    GAMSEquationRecord firstRecord(const std::string& key1, const std::string& key2, const std::string& key3);


    GAMSEquationRecord lastRecord(const std::vector<std::string>& slice);


    GAMSEquationRecord lastRecord();


    GAMSEquationRecord lastRecord(const std::string& key1);


    GAMSEquationRecord lastRecord(const std::string& key1, const std::string& key2);


    GAMSEquationRecord lastRecord(const std::string& key1, const std::string& key2, const std::string& key3);


    GAMSEquationRecord addRecord(const std::vector<std::string>& keys);


    GAMSEquationRecord addRecord();


    GAMSEquationRecord addRecord(const std::string& key1);


    GAMSEquationRecord addRecord(const std::string& key1, const std::string& key2);


    GAMSEquationRecord addRecord(const std::string& key1, const std::string& key2, const std::string& key3);


    GAMSEquationRecord findRecord(const std::vector<std::string>& keys);


    GAMSEquationRecord findRecord();


    GAMSEquationRecord findRecord(const std::string& key1);


    GAMSEquationRecord findRecord(const std::string& key1, const std::string& key2);


    GAMSEquationRecord findRecord(const std::string& key1, const std::string& key2, const std::string& key3);


    GAMSEquationRecord mergeRecord(const std::vector<std::string>& keys);


    GAMSEquationRecord mergeRecord();


    GAMSEquationRecord mergeRecord(const std::string& key1);


    GAMSEquationRecord mergeRecord(const std::string& key1, const std::string& key2);


    GAMSEquationRecord mergeRecord(const std::string& key1, const std::string& key2, const std::string& key3);


    GAMSEnum::EquType equType();


private:

    friend class GAMSDatabaseImpl;

    friend class GAMSSymbolIter<GAMSEquation>;


    GAMSEquation(GAMSDatabase& database, void *symPtr, int dim, std::string name, std::string text

                 , GAMSEnum::EquType eqType);


    GAMSEquation(GAMSDatabase& database, const std::string& name, const int dim, const std::string& text

                 , GAMSEnum::EquType equType);


    GAMSEquation(GAMSDatabase& database, const std::string& name, const std::string& text

                 , const std::vector<GAMSDomain>& domains, GAMSEnum::EquType equType);

};


} // namespace gams


#endif // GAMSEQUATION_H

gams::GAMSDatabase
Definition: gamsdatabase.h:175

gams::GAMSEnum::EquType
EquType
Equation subtype.
Definition: gamsenum.h:58

gams::GAMSEquationRecord
This class represents a single record of a GAMSEquation.
Definition: gamsequationrecord.h:37

gams::GAMSEquation
Definition: gamsequation.h:37

gams::GAMSEquation::mergeRecord
GAMSEquationRecord mergeRecord(const std::string &key1, const std::string &key2, const std::string &key3)

gams::GAMSEquation::findRecord
GAMSEquationRecord findRecord(const std::string &key1, const std::string &key2)

gams::GAMSEquation::addRecord
GAMSEquationRecord addRecord(const std::string &key1, const std::string &key2, const std::string &key3)

gams::GAMSEquation::begin
GAMSSymbolIter< GAMSEquation > begin()

gams::GAMSEquation::lastRecord
GAMSEquationRecord lastRecord(const std::string &key1, const std::string &key2, const std::string &key3)

gams::GAMSEquation::GAMSEquation
GAMSEquation(const GAMSSymbol &other)

gams::GAMSEquation::lastRecord
GAMSEquationRecord lastRecord(const std::string &key1, const std::string &key2)

gams::GAMSEquation::findRecord
GAMSEquationRecord findRecord(const std::vector< std::string > &keys)

gams::GAMSEquation::firstRecord
GAMSEquationRecord firstRecord(const std::string &key1, const std::string &key2, const std::string &key3)

gams::GAMSEquation::mergeRecord
GAMSEquationRecord mergeRecord(const std::string &key1)

gams::GAMSEquation::GAMSEquation
GAMSEquation()
Standard constructor.
Definition: gamsequation.h:43

gams::GAMSEquation::lastRecord
GAMSEquationRecord lastRecord(const std::vector< std::string > &slice)

gams::GAMSEquation::~GAMSEquation
~GAMSEquation()
Destructor.

gams::GAMSEquation::end
GAMSSymbolIter< GAMSEquation > end()

gams::GAMSEquation::findRecord
GAMSEquationRecord findRecord()

gams::GAMSEquation::addRecord
GAMSEquationRecord addRecord(const std::string &key1)

gams::GAMSEquation::equType
GAMSEnum::EquType equType()
Retrieve subtype of Equation (E: Equal, G: Greater, L: Less, N: No specification, X: External defined...

gams::GAMSEquation::lastRecord
GAMSEquationRecord lastRecord()

gams::GAMSEquation::findRecord
GAMSEquationRecord findRecord(const std::string &key1, const std::string &key2, const std::string &key3)

gams::GAMSEquation::addRecord
GAMSEquationRecord addRecord(const std::string &key1, const std::string &key2)

gams::GAMSEquation::mergeRecord
GAMSEquationRecord mergeRecord()

gams::GAMSEquation::lastRecord
GAMSEquationRecord lastRecord(const std::string &key1)

gams::GAMSEquation::firstRecord
GAMSEquationRecord firstRecord(const std::string &key1, const std::string &key2)

gams::GAMSEquation::mergeRecord
GAMSEquationRecord mergeRecord(const std::vector< std::string > &keys)

gams::GAMSEquation::firstRecord
GAMSEquationRecord firstRecord(const std::string &key1)

gams::GAMSEquation::addRecord
GAMSEquationRecord addRecord()

gams::GAMSEquation::findRecord
GAMSEquationRecord findRecord(const std::string &key1)

gams::GAMSEquation::firstRecord
GAMSEquationRecord firstRecord()

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

gams::GAMSEquation::mergeRecord
GAMSEquationRecord mergeRecord(const std::string &key1, const std::string &key2)

gams::GAMSEquation::addRecord
GAMSEquationRecord addRecord(const std::vector< std::string > &keys)

gams::GAMSEquation::firstRecord
GAMSEquationRecord firstRecord(const std::vector< std::string > &slice)

gams::GAMSSymbolIter
Definition: gamssymboliter.h:38

gams::GAMSSymbol
Definition: gamssymbol.h:49

gams
Definition: gams.h:91