MSElement.hpp

/*
 *  This file is part of the AiBO+ project
 *
 *  Copyright (C) 2005-2016 Csaba Kertész (csaba.kertesz@gmail.com)
 *
 *  AiBO+ is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  AiBO+ 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 General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Street #330, Boston, MA 02111-1307, USA.
 *
 */

#pragma once

#include <qlist.h>
#include <qmap.h>
#include <qmetatype.h>
#include <qmutex.h>
#include <qobject.h>
#include <qstringlist.h>
#include <QTime>

class MSData;
class MSElement;
class MSHeart;

namespace MS
{
typedef enum
{
  Source,            
  Sink,              
  SinkGui,           
  NormalElement,     
} ElementType;

typedef QMap<QString, MSElement*> StringElementMap;

typedef QMap<QString, MSData*> StringDataMap;

typedef QList<MSElement*> ElementPtrList;
}

class MSElement : public QObject
{
  Q_OBJECT;

  friend class MSHeart;
  friend class MSSessionStorage;

public:

  explicit MSElement(MS::ElementType element_type, bool dedicated_thread = false);
  virtual ~MSElement();

  bool IsDedicatedThread() const;

  int GetElementID() const;

  void SetElementID(int new_id);

  int GetBeatID() const;

  MS::ElementType GetType() const;

  QString GetClass() const;

public Q_SLOTS:

  void BeatBegin(int beat_id);

  void Stop();

private Q_SLOTS:

  void ProgressIdle();

private:

  bool DoTasks(bool be_hurry);

protected:

  virtual void StartActivities();

  virtual bool ProgressTasks(bool be_hurry);

  virtual void StopActivities();

public:

  QStringList GetInputList() const;

  bool HasOutputs() const;

  QStringList GetOutputList() const;

  void AddReceiverElement(const QString& output_name, MSElement& element);

  void RemoveReceiverElement(const QString& output_name, MSElement& element);

protected:

  MSData* GetOutputData(const QString& output_name) const;

  void SetInputData(const QString& input_name, const MSData& new_data);

  void Feeding();

Q_SIGNALS:

  void BeatEnd(int beat_id, MSElement* element);

protected:
  bool DedicatedThread;
  int ElementID;
  int CurrentBeat;
  MS::StringElementMap ReceiverElements;
  bool PlaybackMode;
  QStringList CurrentOutputList;
  QStringList CurrentInputList;
  MS::ElementType Type;
  MS::StringDataMap InputList;
  MS::StringDataMap OutputList;
  bool EmergencyStop;
  MSHeart* Heart;
  QMutex TasksExecutionMutex;
};

Q_DECLARE_METATYPE(MSElement*); // -V566 (PVS Studio suppression)