CLogicsComponent.hpp

Go to the documentation of this file.

#ifndef LIBS_LOGIC_CLOGICSCOMPONENT_HPP_
#define LIBS_LOGIC_CLOGICSCOMPONENT_HPP_
 
#include "filehandlers/xmlFile.hpp"
#include "logic/CLogicsAllowed.hpp"
#include "logic/components/CLogicsConnectionPoint.hpp"
#include "logic/types.hpp"
#include "ui/gui/AbstractCanvasItem.hpp"
 
#include <bits/stdint-uintn.h>
#include <cstddef>
#include <map>
#include <string>
#include <tuple>
#include <vector>
 
class CLogicsComponent : public AbstractLogicsElement, public std::enable_shared_from_this<CLogicsComponent>
{
public:
    typedef std::map<AbstractCanvasItem::TId, std::shared_ptr<CLogicsConnectionPoint>> TMapIdConnPoint;
 
    static iv::logic::eGeneralType enumGeneralType(const std::string &strType);
 
    static std::string strGeneralType(iv::logic::eGeneralType generalType);
 
    static iv::types::logic::ComponentType readLogicsComponentTypeTuple(
            const iv::file::xml::node &node);// need to read first the type in order to read the rest of the component.
    static bool hasExecutionOrder(const iv::types::logic::ComponentType &componentTypeTuple);
    static bool isExecBlock(const iv::types::logic::ComponentType &componentTypeTuple);
    static bool isLibraryBlock(const iv::types::logic::ComponentType &componentTypeTuple);
 
    explicit CLogicsComponent(const iv::types::logic::ComponentType &componentTypeTuple);
    CLogicsComponent(AbstractCanvasItem::TId id, const iv::types::logic::ComponentType &componentTypeTuple,
                     const std::string &name);
    CLogicsComponent() = delete;
    ~CLogicsComponent() override = default;
    CLogicsComponent(const CLogicsComponent &other) = delete;
    CLogicsComponent(CLogicsComponent &&other) = delete;
    CLogicsComponent &operator=(const CLogicsComponent &other) = delete;
    CLogicsComponent &operator=(CLogicsComponent &&other) = delete;
 
    iv::file::xml::node read(const iv::file::xml::node &node) override;
    iv::file::xml::node save(iv::file::xml::node &node) const override;
 
    std::vector<std::shared_ptr<AbstractCanvasItem>> getLinkedItems() override;
    void updateLinkedItems() override;
    void resetLinkedItems() override;
 
    void addConnectionPointInput(const std::shared_ptr<CLogicsConnectionPoint> &connectionPoint);
    void addConnectionPointOutput(const std::shared_ptr<CLogicsConnectionPoint> &connectionPoint);
 
    [[nodiscard]] size_t numberOfInputs() const;
    [[nodiscard]] size_t numberOfOutputs() const;
 
    [[nodiscard]] bool isAllConnected() const;
 
    [[nodiscard]] const iv::types::logic::componentFinalType &getComponentFinalType() const;
    [[nodiscard]] const iv::logic::eGeneralType &getComponentGeneralType() const;
    [[nodiscard]] const iv::types::logic::componentType &getComponentType() const;
    [[nodiscard]] const iv::types::logic::ComponentType &getComponentTypeTuple() const;
    [[nodiscard]] std::shared_ptr<CLogicsConnectionPoint> getConnectionPoint(iv::logic::eDBBlockParamType pointType,
                                                                             iv::types::logic::paramNumber paramNum);
    [[nodiscard]] std::shared_ptr<CLogicsConnectionPoint> getFirstInputConnectionPoint() const;
    [[nodiscard]] std::shared_ptr<CLogicsConnectionPoint> getInputConnectionPoint(uint32_t index);
    [[nodiscard]] std::shared_ptr<CLogicsConnectionPoint> getFirstOutputConnectionPoint() const;
    [[nodiscard]] std::shared_ptr<CLogicsConnectionPoint> getOutputConnectionPoint(uint32_t index);
    TMapIdConnPoint getInputRefs();
    [[nodiscard]] const TMapIdConnPoint &getInputRefsConst() const;
    TMapIdConnPoint getOutputRefs();
    [[nodiscard]] const TMapIdConnPoint &getOutputRefsConst() const;
 
    [[nodiscard]] std::set<std::shared_ptr<CLogicsConnectionPoint>> getConnectionPoints() const;
 
protected:
    virtual std::optional<uint32_t> getIndexOfConnectionForParam(iv::logic::eDBBlockParamType type,
                                                                 iv::types::logic::paramNumber number) const;
 
private:
    iv::types::logic::ComponentType m_componentTypeTuple;
    TMapIdConnPoint m_inputRefs;
    TMapIdConnPoint m_outputRefs;
};
 
#endif /* LIBS_LOGIC_CLOGICSCOMPONENT_HPP_ */