######################################################################################################################
# Copyright (C) 2017-2020 Spine project consortium
# This file is part of Spine Toolbox.
# Spine Toolbox is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
# Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
# any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
# without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General
# Public License for more details. You should have received a copy of the GNU Lesser General Public License along with
# this program. If not, see <http://www.gnu.org/licenses/>.
######################################################################################################################
"""
Contains GDXConnector class and a help function.
:author: P. Vennström (VTT)
:date: 1.6.2019
"""
from gdx2py import GdxFile, GAMSParameter, GAMSScalar, GAMSSet
from PySide2.QtWidgets import QFileDialog
from ..io_api import SourceConnection
from ..gdx_utils import find_gams_directory
[docs]def select_gdx_file(parent=None):
"""
Launches QFileDialog with .gdx filter
"""
return QFileDialog.getOpenFileName(parent, "", "*.gdx")
[docs]class GdxConnector(SourceConnection):
"""Template class to read data from another QThread."""
"""name of data source"""
"""dict with option specification for source"""
[docs] SELECT_SOURCE_UI = select_gdx_file
"""Modal widget that returns source object and action (OK, CANCEL)."""
def __init__(self):
super().__init__()
self._filename = None
self._gdx_file = None
self._gams_dir = find_gams_directory()
[docs] def __exit__(self, exc_type, exc_value, traceback):
self.disconnect()
[docs] def __del__(self):
self.disconnect()
[docs] def connect_to_source(self, source):
"""
Connects to given .gdx file.
Args:
source (str): path to .gdx file.
"""
if self._gams_dir is None:
raise IOError(f"Could not find GAMS directory. Make sure that you have GAMS installed.")
self._filename = source
self._gdx_file = GdxFile(source, gams_dir=self._gams_dir)
[docs] def disconnect(self):
"""Disconnects from connected source."""
if self._gdx_file is not None:
self._gdx_file.close()
[docs] def get_tables(self):
"""
Returns a list of table names.
GAMS scalars are also regarded as tables.
Returns:
list(str): Table names in list
"""
tables = []
for symbol in self._gdx_file:
tables.append(symbol[0])
return tables
[docs] def get_data_iterator(self, table, options, max_rows=-1):
"""Creates an iterator for the data source
Arguments:
table (string): table name
options (dict): dict with options
Keyword Arguments:
max_rows (int): ignored
Returns:
tuple: data iterator, list of column names, number of columns
"""
if not table in self._gdx_file:
return iter([]), [], 0
symbol = self._gdx_file[table]
header = list(symbol.domain) if symbol.domain is not None else []
if isinstance(symbol, GAMSSet):
if not header:
# It is domain, use generalized index '*'.
header.append("*")
if symbol.elements and isinstance(symbol.elements[0], str):
def gdx_data():
for key in symbol.elements:
yield [key]
else:
def gdx_data():
for keys in symbol.elements:
yield list(keys)
elif isinstance(symbol, GAMSParameter):
header.append("Value")
symbol_keys = list(symbol.keys())
if symbol_keys and isinstance(symbol_keys[0], str):
def gdx_data():
for keys, value in zip(symbol_keys, symbol.values()):
yield [keys] + [value]
else:
def gdx_data():
for keys, value in zip(symbol_keys, symbol.values()):
yield list(keys) + [value]
elif isinstance(symbol, GAMSScalar):
header.append("Value")
def gdx_data():
yield [float(symbol)]
else:
raise RuntimeError("Unknown GAMS symbol type.")
return gdx_data(), header, len(header)