transceiver_function.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_FUNCTION_H
#define TRANSCEIVER_FUNCTION_H
 
#include "nrp_general_library/transceiver_function/transceiver_datapack_interface.h"
 
#include "nrp_general_library/transceiver_function/function_manager.h"
#include "nrp_general_library/engine_interfaces/engine_client_interface.h"
 
#include <string>
#include <boost/python.hpp>
 
class TransceiverFunction
        : public TransceiverDataPackInterface,
          public PtrTemplates<TransceiverFunction>
{
    public:
        TransceiverFunction(std::string linkedEngine, bool isPreprocessing);
        virtual ~TransceiverFunction() override = default;
 
        const std::string &linkedEngineName() const override;
 
        bool isPreprocessing() const override;
 
        TransceiverDataPackInterface::shared_ptr pySetup(boost::python::object transceiverFunction);
 
        boost::python::object runTf(boost::python::tuple &args, boost::python::dict &kwargs, datapacks_set_t dataPacks) override;
 
    protected:
        datapack_identifiers_set_t getRequestedDataPackIDs() const override;
 
        datapack_identifiers_set_t updateRequestedDataPackIDs(datapack_identifiers_set_t &&datapackIDs) const override;
 
    private:
        boost::python::object _function;
 
        std::string _linkedEngine;
 
        bool _isPreprocessing;
 
        TransceiverDataPackInterface::shared_ptr *_tfInterpreterRegistryPtr = nullptr;
 
        TransceiverDataPackInterface::shared_ptr *getTFInterpreterRegistry() override final;
 
        void checkTFOutputIsCorrectOrRaise(const boost::python::object &tfOutput) const;
};
 
#endif // TRANSCEIVER_FUNCTION_H