input_port.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_PORT_H
#define INPUT_PORT_H
 
#include <functional>
#include <sstream>
 
#include "nrp_general_library/utils/nrp_exceptions.h"
 
#include "nrp_event_loop/utils/data_conversion.h"
 
#include "nrp_event_loop/computational_graph/port.h"
#include "nrp_event_loop/computational_graph/output_port.h"
#include "nrp_event_loop/computational_graph/computational_node.h"
 
template <class T_IN, class T_OUT>
class InputPort : public Port {
public:
 
    InputPort(const std::string& id, ComputationalNode* parent, std::function<void(const T_OUT*)> callback, std::size_t maxSubs = 0) :
            Port(id, parent),
            _callback(callback),
            _maxSubs(maxSubs)
    {}
 
    void subscribeTo(OutputPort<T_IN>* port)
    {
        if(_maxSubs && _nSubs >= _maxSubs) {
            std::stringstream s;
            s << "Port \"" << this->id() << "\" of node \"" << this->parent()->id() << "\" can only have " << _maxSubs << " subscriber(s)";
            throw NRPException::logCreate(s.str());
        }
 
        using std::placeholders::_1;
        std::function<void(const T_IN*)> receive_f = std::bind(&InputPort<T_IN,T_OUT>::receive, this, _1);
        port->add_subscriber(receive_f);
 
        _nSubs++;
    }
 
    size_t subscriptionsSize() override
    { return _nSubs; }
 
    size_t subscriptionsMax()
    { return _maxSubs == 0 ? SIZE_MAX : _maxSubs; }
 
private:
 
    void receive(const T_IN* msg)
    {
        if ( msg == nullptr ) {
            _callback(nullptr);
            return;
        }
 
        if constexpr ( std::is_same_v<T_IN, T_OUT> )
            _callback(msg);
        else {
            dataConverter<T_IN, T_OUT>::convert(msg, _data);
            _callback(&_data);
        }
    }
 
    T_OUT _data;
    std::function<void(const T_OUT*)> _callback;
    std::size_t _maxSubs;
    std::size_t _nSubs = 0;
};
 
 
#endif //INPUT_PORT_H