input_node.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 INPUT_ENGINE_NODE_H
#define INPUT_ENGINE_NODE_H
 
#include <boost/python.hpp>
#include <mutex>
 
#include "nrp_general_library/datapack_interface/datapack_interface.h"
#include "nrp_general_library/engine_interfaces/engine_client_interface.h"
 
#include "nrp_event_loop/computational_graph/input_node.h"
#include "nrp_event_loop/python/input_edge.h"
 
class InputEngineNode : public InputNode<DataPackInterface> {
public:
 
    InputEngineNode(const std::string &id, const std::string &engineName) :
            InputNode(id),
            _engineName(engineName)
    {}
 
    std::string typeStr() const override
    { return "FromEngine"; }
 
    const std::set<DataPackIdentifier>& requestedDataPacks() const
    { return _dataIds; }
 
    void setDataPacks(datapacks_vector_t dpacks)
    {
        std::lock_guard<std::mutex> lock(_dataMutex);
 
        // TODO: in order to use MsgPublishPolicy::ALL policy with this type of node a vector of datapacks should be
        //  store, not just one which is being overwritten
        // move datapacks into temporary storage without copying the shared pointer
        for(auto dpack: dpacks) {
            auto name = dpack->name();
            if(this->_portMap.count(name) && 
               (!_dataTemp.count(name) || !dpack->isEmpty()))
                _dataTemp[name] = std::move(dpack);
        }
    }
 
protected:
 
    void configure() override
    {
        for(auto& [id, port] : _portMap)
            _dataIds.insert(DataPackIdentifier(id, _engineName, ""));
    }
 
    bool updatePortData(const std::string& id) override
    {
        std::lock_guard<std::mutex> lock(_dataMutex);
 
        // move temp datapack to store without copying shared pointer and update pointer,
        // only if there is no dapatapack 'id' stored already or the new one is not empty
        auto d = _dataTemp.find(id);
        if(d != _dataTemp.end() && (!_dataStore.count(id) || !_dataTemp.at(id)->isEmpty())) {
            _portMap.at(id).clear();
 
            _dataStore[id] = std::move(d->second);
            _portMap.at(id).addMsg(_dataStore[id].get());
 
            _dataTemp.erase(d);
 
            return true;
        }
 
        return false;
    }
 
private:
    
    std::string _engineName;
    std::mutex _dataMutex;
    std::map<std::string, DataPackInterfaceConstSharedPtr> _dataTemp;
    std::map<std::string, DataPackInterfaceConstSharedPtr> _dataStore;
    std::set<DataPackIdentifier> _dataIds;
};
 
 
class InputEngineEdge : public SimpleInputEdge<DataPackInterface, InputEngineNode> {
 
public:
 
    InputEngineEdge(const std::string& keyword, const std::string& address,
                    InputNodePolicies::MsgCachePolicy msgCachePolicy) :
            SimpleInputEdge<DataPackInterface, InputEngineNode>(keyword, ComputationalNode::parseNodeAddress(address).first+"_input",
                                                                ComputationalNode::parseNodeAddress(address).second,
                            InputNodePolicies::LAST, msgCachePolicy),
            _engineName(ComputationalNode::parseNodeAddress(address).first)
    {}
 
protected:
 
    InputEngineNode* makeNewNode() override
    { return new InputEngineNode(this->_id, _engineName); }
 
private:
 
    std::string _engineName;
};
 
 
#endif //INPUT_ENGINE_NODE_H