apis/cpp/gamsvariable_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 GAMSVARIABLE_H

#define GAMSVARIABLE_H


#include "gamssymbol.h"

#include "gamsvariablerecord.h"


namespace gams {


class LIBSPEC GAMSVariable : public GAMSSymbol

{

public:

    typedef GAMSVariableRecord RecordType;


    GAMSVariable();


    GAMSVariable(const GAMSSymbol& other);


    ~GAMSVariable();


    GAMSSymbolIter<GAMSVariable> begin();


    GAMSSymbolIter<GAMSVariable> end();


    GAMSVariable& operator=(const GAMSVariable& other);


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


    GAMSVariableRecord firstRecord();


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


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


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


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


    GAMSVariableRecord lastRecord();


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


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


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


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


    GAMSVariableRecord findRecord();


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


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


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


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


    GAMSVariableRecord mergeRecord();


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


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


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


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


    GAMSVariableRecord addRecord();


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


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


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


    GAMSEnum::VarType varType();


private:

    friend class GAMSDatabaseImpl;

    friend class GAMSSymbolIter<GAMSVariable>;

    GAMSVariable(GAMSDatabase& database, void* symPtr, int dim, std::string name, std::string text, GAMSEnum::VarType varType);

    GAMSVariable(GAMSDatabase& database, const std::string& name, const int dim, const std::string& text, GAMSEnum::VarType varType);

    GAMSVariable(GAMSDatabase& database, const std::string& name, const std::string& text, const std::vector<GAMSDomain>& domains, GAMSEnum::VarType varType);

};


} // namespace gams


#endif // GAMSVARIABLE_H

gams::GAMSDatabase
Definition: gamsdatabase.h:175

gams::GAMSEnum::VarType
VarType
Variable subtype.
Definition: gamsenum.h:83

gams::GAMSSymbolIter
Definition: gamssymboliter.h:38

gams::GAMSSymbol
Definition: gamssymbol.h:49

gams::GAMSVariableRecord
This is the representation of a single record of a GAMSVariable.
Definition: gamsvariablerecord.h:37

gams::GAMSVariable
Definition: gamsvariable.h:37

gams::GAMSVariable::lastRecord
GAMSVariableRecord lastRecord(const std::string &key1, const std::string &key2, const std::string &key3)

gams::GAMSVariable::firstRecord
GAMSVariableRecord firstRecord(const std::string &key1, const std::string &key2)

gams::GAMSVariable::firstRecord
GAMSVariableRecord firstRecord()

gams::GAMSVariable::lastRecord
GAMSVariableRecord lastRecord()

gams::GAMSVariable::mergeRecord
GAMSVariableRecord mergeRecord(const std::string &key1, const std::string &key2)

gams::GAMSVariable::addRecord
GAMSVariableRecord addRecord(const std::string &key1, const std::string &key2)

gams::GAMSVariable::findRecord
GAMSVariableRecord findRecord()

gams::GAMSVariable::findRecord
GAMSVariableRecord findRecord(const std::vector< std::string > &keys)

gams::GAMSVariable::~GAMSVariable
~GAMSVariable()
Destructor.

gams::GAMSVariable::addRecord
GAMSVariableRecord addRecord(const std::vector< std::string > &keys)

gams::GAMSVariable::addRecord
GAMSVariableRecord addRecord()

gams::GAMSVariable::lastRecord
GAMSVariableRecord lastRecord(const std::string &key1)

gams::GAMSVariable::findRecord
GAMSVariableRecord findRecord(const std::string &key1, const std::string &key2, const std::string &key3)

gams::GAMSVariable::addRecord
GAMSVariableRecord addRecord(const std::string &key1, const std::string &key2, const std::string &key3)

gams::GAMSVariable::mergeRecord
GAMSVariableRecord mergeRecord(const std::string &key1)

gams::GAMSVariable::mergeRecord
GAMSVariableRecord mergeRecord(const std::vector< std::string > &keys)

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

gams::GAMSVariable::firstRecord
GAMSVariableRecord firstRecord(const std::vector< std::string > &slice)

gams::GAMSVariable::firstRecord
GAMSVariableRecord firstRecord(const std::string &key1)

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

gams::GAMSVariable::lastRecord
GAMSVariableRecord lastRecord(const std::vector< std::string > &slice)

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

gams::GAMSVariable::varType
GAMSEnum::VarType varType()
Retrieve subtype of variable (Binary, Integer, Positive, Negative, Free, SOS1, SOS2,...

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

gams::GAMSVariable::addRecord
GAMSVariableRecord addRecord(const std::string &key1)

gams::GAMSVariable::findRecord
GAMSVariableRecord findRecord(const std::string &key1, const std::string &key2)

gams::GAMSVariable::mergeRecord
GAMSVariableRecord mergeRecord()

gams::GAMSVariable::findRecord
GAMSVariableRecord findRecord(const std::string &key1)

gams::GAMSVariable::lastRecord
GAMSVariableRecord lastRecord(const std::string &key1, const std::string &key2)

gams::GAMSVariable::mergeRecord
GAMSVariableRecord mergeRecord(const std::string &key1, const std::string &key2, const std::string &key3)

gams::GAMSVariable::GAMSVariable
GAMSVariable()
Standard constructor.

gams::GAMSVariable::firstRecord
GAMSVariableRecord firstRecord(const std::string &key1, const std::string &key2, const std::string &key3)

gams
Definition: gams.h:91