class InputEngineNode

Overview

Input node used to connect an EngineClient with the computational graph. More…

#include <input_node.h>

class InputEngineNode: public InputNode {
public:
    // construction

    InputEngineNode(const std::string& id, const std::string& engineName);

    // methods

    virtual std::string typeStr() const;
    const std::set<DataPackIdentifier>& requestedDataPacks() const;
    void setDataPacks(datapacks_vector_t dpacks);
};

Inherited Members

public:
    // enums

    enum NodeType;

    // fields

    static const static std::map<NodeType, std::string> nodeTypeStr = {{ComputationalNode::Input, "Input"},                                                                                            {ComputationalNode::Output, "Output"},                                                                                            {ComputationalNode::Functional, "Functional"}};

    // methods

    const std::string& id() const;
    NodeType type() const;
    virtual std::string typeStr() const;
    void setVisited(bool visited);
    bool isVisited() const;
    void setDoCompute(bool doCompute);
    virtual bool doCompute() const;

    static std::pair<std::string, std::string> parseNodeAddress(
        const std::string& address,
        bool hasPort = true
    );

    void registerOutput(const std::string& id);
    OutputPort<DATA>* getSinglePort(const std::string& id);
    OutputPort<std::vector<const DATA*>>* getListPort(const std::string& id);
    InputNodePolicies::MsgPublishPolicy msgPublishPolicy();
    InputNodePolicies::MsgCachePolicy msgCachePolicy();
    void setMsgPublishPolicy(InputNodePolicies::MsgPublishPolicy msgPublishPolicy);
    void setMsgCachePolicy(InputNodePolicies::MsgCachePolicy msgCachePolicy);

Detailed Documentation

Input node used to connect an EngineClient with the computational graph.

It has two methods ‘requestedDataPacks’ and ‘setDataPacks’ which allows to update the node externally with the latest datapacks

Construction

InputEngineNode(const std::string& id, const std::string& engineName)

Constructor

Methods

virtual std::string typeStr() const

Returns the node ‘type’ as a string.

const std::set<DataPackIdentifier>& requestedDataPacks() const

Get the set of DataPackInterfaces that this node requests

void setDataPacks(datapacks_vector_t dpacks)

Set datapacks to be published into the graph in the next call to ‘compute’