BlockInformation.h

Go to the documentation of this file.

/*
 * Copyright (C) 2018 Istituto Italiano di Tecnologia (IIT)
 * All rights reserved.
 *
 * This software may be modified and distributed under the terms of the
 * GNU Lesser General Public License v2.1 or any later version.
 */

#ifndef BLOCKFACTORY_CORE_BLOCKINFORMATION_H
#define BLOCKFACTORY_CORE_BLOCKINFORMATION_H

#include "BlockFactory/Core/Port.h"

#include <memory>
#include <string>
#include <tuple>
#include <utility>
#include <vector>

namespace blockfactory {
    namespace core {
        class BlockInformation;
        class ParameterMetadata;
        class Parameters;
        class Signal;
        using InputPortsInfo = std::vector<Port::Info>;
        using OutputPortsInfo = std::vector<Port::Info>;
        using InputSignalPtr = std::shared_ptr<const blockfactory::core::Signal>;
        using OutputSignalPtr = std::shared_ptr<blockfactory::core::Signal>;

        // List of possible keys for defining block options:
        const std::string BlockOptionPrioritizeOrder = "wbt.BlockOptionPrioritizeOrder";
    } // namespace core
} // namespace blockfactory

class blockfactory::core::BlockInformation
{
public:
    BlockInformation() = default;
    virtual ~BlockInformation() = default;

    virtual bool getUniqueName(std::string& blockUniqueName) const = 0;

    // =====================
    // BLOCK OPTIONS METHODS
    // =====================

    virtual bool optionFromKey(const std::string& key, double& option) const = 0;

    // ==================
    // PARAMETERS METHODS
    // ==================

    virtual bool parseParameters(Parameters& parameters) = 0;

    virtual bool addParameterMetadata(const ParameterMetadata& paramMD) = 0;

    // ========================
    // PORT INFORMATION SETTERS
    // ========================

    virtual bool setPortsInfo(const InputPortsInfo& inputPortsInfo,
                              const OutputPortsInfo& outputPortsInfo) = 0;

    // ========================
    // PORT INFORMATION GETTERS
    // ========================

    virtual Port::Info getInputPortInfo(Port::Index idx) const = 0;

    virtual Port::Info getOutputPortInfo(Port::Index idx) const = 0;

    virtual Port::Size::Vector getInputPortWidth(const Port::Index idx) const = 0;

    virtual Port::Size::Vector getOutputPortWidth(const Port::Index idx) const = 0;

    virtual Port::Size::Matrix getInputPortMatrixSize(const Port::Index idx) const = 0;

    virtual Port::Size::Matrix getOutputPortMatrixSize(const Port::Index idx) const = 0;

    // =============
    // BLOCK SIGNALS
    // =============

    virtual InputSignalPtr getInputPortSignal(const Port::Index idx) const = 0;

    virtual OutputSignalPtr getOutputPortSignal(const Port::Index idx) const = 0;
};

#endif // BLOCKFACTORY_CORE_BLOCKINFORMATION_H