transceiver_datapack_interface.h

Go to the documentation of this file.

/* * NRP Core - Backend infrastructure to synchronize simulations
 *
 * Copyright 2020-2023 NRP Team
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * This project has received funding from the European Union’s Horizon 2020
 * Framework Programme for Research and Innovation under the Specific Grant
 * Agreement No. 945539 (Human Brain Project SGA3).
 */
 
#ifndef TRANSCEIVER_DATAPACK_INTERFACE_H
#define TRANSCEIVER_DATAPACK_INTERFACE_H
 
#include "nrp_general_library/engine_interfaces/engine_client_interface.h"
#include "nrp_general_library/utils/ptr_templates.h"
 
//#include "nrp_general_library/transceiver_function/transceiver_function_interpreter.h"
 
#include <boost/python.hpp>
 
class FunctionManager;
using TransceiverFunctionInterpreterSharedPtr = std::shared_ptr<FunctionManager>;
using TransceiverFunctionInterpreterConstSharedPtr = std::shared_ptr<const FunctionManager>;
 
 
class TransceiverDataPackInterface
        : public PtrTemplates<TransceiverDataPackInterface>
{
    public:
        TransceiverDataPackInterface() = default;
        virtual ~TransceiverDataPackInterface() = default;
 
        template<class TRANSCEIVER_DATAPACK>
        TransceiverDataPackInterface::shared_ptr pySetup(const TransceiverDataPackInterface::shared_ptr &tfDataPack)
        {
            static_assert((std::is_base_of_v<TransceiverDataPackInterface, TRANSCEIVER_DATAPACK>) || (std::is_same_v<TransceiverDataPackInterface, TRANSCEIVER_DATAPACK>),"Parameter TRANSCEIVER_DATAPACK must derive from TransceiverDataPackInterface or be same");
 
            this->_nextDecorator = tfDataPack;
 
            auto thisPtr = this->moveToSharedPtr<TRANSCEIVER_DATAPACK>();
 
            TransceiverDataPackInterface::shared_ptr *const registryPtr = this->_nextDecorator->getTFInterpreterRegistry();
            assert(registryPtr != nullptr);
 
            *registryPtr = thisPtr;
            return thisPtr;
        }
 
        virtual const std::string &linkedEngineName() const;
 
        virtual bool isPreprocessing() const;
 
        virtual boost::python::object runTf(boost::python::tuple &args, boost::python::dict &kwargs, datapacks_set_t dataPacks);
 
        virtual datapack_identifiers_set_t updateRequestedDataPackIDs(datapack_identifiers_set_t &&datapackIDs = datapack_identifiers_set_t()) const;
 
        virtual datapack_identifiers_set_t getRequestedDataPackIDs() const;
 
        static void setTFInterpreter(FunctionManager *interpreter);
        static const FunctionManager * getFunctionManager()
        {
            return TransceiverDataPackInterface::_functionManager;
        }
 
    protected:
        static FunctionManager *_functionManager;
 
        template<class TRANSCEIVER_DATAPACK>
        typename PtrTemplates<TRANSCEIVER_DATAPACK>::shared_ptr moveToSharedPtr()
        {
            static_assert((std::is_base_of_v<TransceiverDataPackInterface, TRANSCEIVER_DATAPACK>) || (std::is_same_v<TransceiverDataPackInterface, TRANSCEIVER_DATAPACK>),"Parameter TRANSCEIVER_DATAPACK must derive from TransceiverDataPackInterface or be same");
            return typename PtrTemplates<TRANSCEIVER_DATAPACK>::shared_ptr(new TRANSCEIVER_DATAPACK(std::move(static_cast<TRANSCEIVER_DATAPACK&>(*this))));
        }
 
        virtual TransceiverDataPackInterface::shared_ptr *getTFInterpreterRegistry();
 
    private:
        TransceiverDataPackInterface::shared_ptr _nextDecorator;
};
 
using TransceiverDataPackInterfaceSharedPtr = TransceiverDataPackInterface::shared_ptr;
using TransceiverDataPackInterfaceConstSharedPtr = TransceiverDataPackInterface::const_shared_ptr;
 
#endif