Block.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_BLOCK_H
#define BLOCKFACTORY_CORE_BLOCK_H

#include "BlockFactory/Core/Parameters.h"

#include <string>
#include <vector>

namespace blockfactory {
    namespace core {
        class Block;
        class BlockInformation;
    } // namespace core
} // namespace blockfactory

class blockfactory::core::Block
{
protected:
    Parameters m_parameters;

public:
    virtual ~Block() = default;

    std::string getUniqueName(const BlockInformation* blockInfo) const;

    static constexpr unsigned NumberOfParameters = 2;

    virtual unsigned numberOfParameters();

    virtual std::vector<std::string> additionalBlockOptions();

    virtual unsigned numberOfDiscreteStates();

    virtual unsigned numberOfContinuousStates();

    virtual bool updateDiscreteState(const BlockInformation* blockInfo);

    virtual bool stateDerivative(const BlockInformation* blockInfo);

    virtual bool parameterAtIndexIsTunable(unsigned index);

    virtual bool parseParameters(BlockInformation* blockInfo);

    bool getParameters(blockfactory::core::Parameters& params) const;

    virtual bool configureSizeAndPorts(BlockInformation* blockInfo);

    virtual bool initialize(BlockInformation* blockInfo);

    virtual bool initializeInitialConditions(const BlockInformation* blockInfo);

    virtual bool terminate(const BlockInformation* blockInfo);

    virtual bool output(const BlockInformation* blockInfo) = 0;
};

#endif // BLOCKFACTORY_CORE_BLOCK_H