ResInsight/ApplicationLibCode/FileInterface/RifCsvUserData.cpp

/////////////////////////////////////////////////////////////////////////////////
//
//  Copyright (C) 2017- Statoil ASA
//
//  ResInsight is free software: you can redistribute it and/or modify
//  it under the terms of the GNU General Public License as published by
//  the Free Software Foundation, either version 3 of the License, or
//  (at your option) any later version.
//
//  ResInsight 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 General Public License at <http://www.gnu.org/licenses/gpl.html>
//  for more details.
//
/////////////////////////////////////////////////////////////////////////////////

#include "RifCsvUserData.h"

#include "RiaDateStringParser.h"
#include "RiaLogging.h"
#include "RiaQDateTimeTools.h"

#include "RifCsvUserDataParser.h"
#include "RifEclipseUserDataKeywordTools.h"
#include "RifEclipseUserDataParserTools.h"

#include "cafUtils.h"

#include <QDateTime>
#include <QFile>
#include <QTextStream>
#include <memory>

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
RifCsvUserData::RifCsvUserData()
{
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
RifCsvUserData::~RifCsvUserData()
{
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
bool RifCsvUserData::parse( const QString& fileName, const RifAsciiDataParseOptions& parseOptions, QString* errorText )
{
    m_allResultAddresses.clear();
    m_mapFromAddressToResultIndex.clear();

    m_parser = std::make_unique<RifCsvUserDataFileParser>( fileName, errorText );
    if ( !m_parser->parse( parseOptions ) )
    {
        RiaLogging::error( QString( "Failed to parse file" ) );
        return false;
    }

    buildTimeStepsAndMappings();

    return true;
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
std::pair<bool, std::vector<double>> RifCsvUserData::values( const RifEclipseSummaryAddress& resultAddress ) const
{
    std::vector<double> values;
    auto                search = m_mapFromAddressToResultIndex.find( resultAddress );
    if ( search != m_mapFromAddressToResultIndex.end() )
    {
        size_t columnIndex = search->second;

        const Column* ci = m_parser->columnInfo( columnIndex );
        if ( !ci ) return { false, {} };

        values.reserve( ci->values.size() );
        for ( double val : ci->values )
        {
            values.push_back( val );
        }
    }

    return { true, values };
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
std::vector<time_t> RifCsvUserData::timeSteps( const RifEclipseSummaryAddress& resultAddress ) const
{
    // First, check whether date time values exist for the current address
    auto search = m_mapFromAddressToResultIndex.find( resultAddress );
    if ( search != m_mapFromAddressToResultIndex.end() )
    {
        size_t index = m_mapFromAddressToResultIndex.at( resultAddress );
        if ( !m_parser->tableData().columnInfos()[index].dateTimeValues.empty() )
        {
            return m_parser->tableData().columnInfos()[index].dateTimeValues;
        }
    }

    // Then check for a separate date time column
    int index = m_parser->tableData().dateTimeColumnIndex();
    if ( index >= 0 )
    {
        return m_parser->tableData().columnInfos()[index].dateTimeValues;
    }

    return {};
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
std::string RifCsvUserData::unitName( const RifEclipseSummaryAddress& resultAddress ) const
{
    auto search = m_mapFromAddressToResultIndex.find( resultAddress );
    if ( search != m_mapFromAddressToResultIndex.end() )
    {
        size_t columnIndex = search->second;

        const Column* ci = m_parser->columnInfo( columnIndex );
        if ( ci )
        {
            return ci->unitName;
        }
    }

    return "";
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
RiaDefines::EclipseUnitSystem RifCsvUserData::unitSystem() const
{
    return RiaDefines::EclipseUnitSystem::UNITS_UNKNOWN;
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RifCsvUserData::buildTimeStepsAndMappings()
{
    auto tableData = m_parser->tableData();

    for ( size_t columnIndex = 0; columnIndex < tableData.columnInfos().size(); columnIndex++ )
    {
        const Column& ci = tableData.columnInfos()[columnIndex];
        if ( ci.dataType == Column::NUMERIC )
        {
            RifEclipseSummaryAddress sumAddress = ci.summaryAddress;

            m_allResultAddresses.insert( sumAddress );
            if ( sumAddress.isErrorResult() ) m_allErrorAddresses.insert( sumAddress );

            m_mapFromAddressToResultIndex[sumAddress] = columnIndex;
        }
    }
}