ResInsight/GrpcInterface/RiaGrpcServiceInterface.h

/////////////////////////////////////////////////////////////////////////////////
//
//  Copyright (C) 2019-     Equinor 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.
//
//////////////////////////////////////////////////////////////////////////////////
#pragma once

#include <grpcpp/grpcpp.h>

#include <vector>

class RiaGrpcCallbackInterface;

namespace caf
{
class PdmChildArrayFieldHandle;
class PdmChildFieldHandle;
class PdmFieldHandle;
class PdmObject;
class PdmObjectHandle;
class PdmScriptIOMessages;
} // namespace caf

namespace rips
{
class PdmObject;
}

class QString;
class QVariant;

//==================================================================================================
//
// gRPC-service interface which all gRPC-services has to implement
//
//==================================================================================================
class RiaGrpcServiceInterface
{
public:
    virtual std::vector<RiaGrpcCallbackInterface*> createCallbacks() = 0;
    virtual ~RiaGrpcServiceInterface()                               = default;

protected:
    static void copyPdmObjectFromCafToRips( const caf::PdmObjectHandle* source, rips::PdmObject* destination );
    static void copyPdmObjectFromRipsToCaf( const rips::PdmObject* source, caf::PdmObjectHandle* destination );

    static caf::PdmObjectHandle*
        emplaceChildField( caf::PdmObject* parent, const QString& fieldKeyword, const QString& keywordForClassToCreate );

    static caf::PdmObjectHandle* emplaceChildField( caf::PdmChildFieldHandle* childField,
                                                    const QString&            keywordForClassToCreate );
    static caf::PdmObjectHandle* emplaceChildArrayField( caf::PdmChildArrayFieldHandle* childArrayField,
                                                         const QString&                 keywordForClassToCreate );

    static bool assignFieldValue( const QString&            stringValue,
                                  caf::PdmFieldHandle*      field,
                                  QVariant*                 oldValue,
                                  QVariant*                 newValue,
                                  caf::PdmScriptIOMessages* messages );
};

#include "cafFactory.h"
using RiaGrpcServiceFactory = caf::Factory<RiaGrpcServiceInterface, size_t>;