AbstractComponent.hpp

/*
 * Copyright 2017 ONERA
 *
 * This file is part of the MAUVE Runtime project.
 *
 * MAUVE Runtime is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3 as
 * published by the Free Software Foundation.
 *
 * MAUVE Runtime is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with MAUVE.  If not, see <https://www.gnu.org/licenses/lgpl-3.0>.
 */
#ifndef MAUVE_RUNTIME_ABSTRACT_COMPONENT_HPP
#define MAUVE_RUNTIME_ABSTRACT_COMPONENT_HPP

#include "Configurable.hpp"
#include "WithName.hpp"
#include "WithAbstractShell.hpp"
#include "WithAbstractCore.hpp"
#include "WithAbstractFSM.hpp"
#include "WithLogger.hpp"
#include "common.hpp"

#include <string>
#include <iostream>
#include <pthread.h>

namespace mauve {
  namespace runtime {

    class Task;
    class AbstractState;
    class ComponentLogger;

    class AbstractComponent
    : virtual public Configurable
    , virtual public WithAbstractShell
    , virtual public WithAbstractCore
    , virtual public WithAbstractFSM
    , virtual public WithLogger
    , virtual public WithName
    {
    public:
      friend class Task;

      AbstractComponent(std::string const & name);
      virtual ~AbstractComponent();

      inline std::string name() const override final { return _name; };
      std::string type_name() const;

      virtual AbstractState * current_state() = 0;

      virtual bool is_empty     () const = 0;
      virtual bool is_created   () const = 0;
      virtual bool is_activated () const = 0;
      virtual bool is_running   () const = 0;

      virtual bool clear() = 0;

      virtual void disconnect() = 0;

      virtual bool step() = 0;

      virtual time_ns_t get_time() const = 0;

      virtual int get_priority() const = 0;

      virtual bool set_priority(int priority) = 0;

      virtual int get_cpu() const = 0;

      virtual bool set_cpu(int cpu) = 0;

    protected:
      ComponentLogger* logger;

    private:
      std::string _name;
      virtual bool run() = 0;
      virtual void set_task(Task* task) = 0;
    };

  } // namespace runtime
} // namespace mauve

#endif // MAUVE_RUNTIME_ABSTRACT_COMPONENT_HPP