MSElement.cpp

/*
 *  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.
 *
 */

#include "MSElement.hpp"

#include "MSContext.hpp"
#include "MSData.hpp"
#include "MSHeart.hpp"

#include <MCDefs.hpp>
#include <MCLog.hpp>

#include <QMutexLocker>
#include <qpointer.h>
#include <qthread.h>
#include <qtimer.h>

static QPointer<MSContext> Context = nullptr;
static int ElementIDs = 0;

MSElement::MSElement(MS::ElementType element_type, bool dedicated_thread) : QObject(),
  DedicatedThread(dedicated_thread), CurrentBeat(-1), PlaybackMode(false),
  CurrentOutputList(), CurrentInputList(), Type(element_type), EmergencyStop(false),
  Heart(nullptr), TasksExecutionMutex(QMutex::Recursive)
{
  ElementIDs++;
  ElementID = ElementIDs;
  MC_LOG("New element: %s (ID: %d, %p) in thread %p", qPrintable(GetClass()),
         ElementID, this, thread());

  Context = MSContext::GetInstance();
  if (Context)
  {
    Context->RegisterElement(*this);
  }
  InputList.clear();
  OutputList.clear();
}


MSElement::~MSElement()
{
  MC_LOG("Delete element: %s (ID: %d, %p) in thread %p", qPrintable(GetClass()),
         ElementID, this, thread());
  // Clear the fed elements mapping
  ReceiverElements.clear();
  if (Context)
  {
    Context->UnregisterElement(*this);
    // Reset the element ID numbering when all elements are unregistered
    if (!Context->HasRegisteredElements())
    {
      ElementIDs = 0;
    }
  }
}


bool MSElement::IsDedicatedThread() const
{
  return DedicatedThread;
}


int MSElement::GetElementID() const
{
  return ElementID;
}


void MSElement::SetElementID(int new_id)
{
  ElementID = new_id;
}


int MSElement::GetBeatID() const
{
  return CurrentBeat;
}


MS::ElementType MSElement::GetType() const
{
  return Type;
}


QString MSElement::GetClass() const
{
  return QString(metaObject()->className());
}


void MSElement::BeatBegin(int beat_id)
{
  // Set the current beat ID
  CurrentBeat = beat_id;
  // Clear the output data list
  CurrentOutputList.clear();
  // Start the data processing
  if ((Type != MS::Source) || (!PlaybackMode && Type == MS::Source))
  {
    QTimer::singleShot(0, this, SLOT(ProgressIdle()));
  } else {
    CurrentInputList.clear();
    Q_EMIT(BeatEnd(CurrentBeat, this));
  }
}


void MSElement::Stop()
{
  EmergencyStop = true;
}


void MSElement::ProgressIdle()
{
  // Stop the idle if the task is done
  if (Heart && (EmergencyStop || DoTasks(Heart->GetRemainingBeatTime() <= 10)))
  {
    CurrentInputList.clear();
    Q_EMIT(BeatEnd(CurrentBeat, this));
    return;
  } else {
    QTimer::singleShot(1, this, SLOT(ProgressIdle()));
    if (!Heart)
    {
      Q_EMIT(BeatEnd(CurrentBeat, this));
    }
  }
}


bool MSElement::DoTasks(bool be_hurry)
{
  QMutexLocker Locker(&TasksExecutionMutex);

  return ProgressTasks(be_hurry);
}


void MSElement::StartActivities()
{
  // No initialization
}


bool MSElement::ProgressTasks(bool be_hurry)
{
  Q_UNUSED(be_hurry)
  // Nothing to do
  return true;
}


void MSElement::StopActivities()
{
  // No deinitialization
}


QStringList MSElement::GetInputList() const
{
  return QStringList(InputList.keys());
}


bool MSElement::HasOutputs() const
{
  return !OutputList.empty();
}


QStringList MSElement::GetOutputList() const
{
  return QStringList(OutputList.keys());
}


void MSElement::AddReceiverElement(const QString& output_name, MSElement& element)
{
  if (output_name.isEmpty())
  {
    MC_WARNING("The output name is not specified.");
    return;
  }
  MC_LOG("Add receiver element: %s (%s) -> %s", qPrintable(GetClass()), qPrintable(output_name),
         qPrintable(element.GetClass()));
  ReceiverElements.insertMulti(output_name, &element);
}


void MSElement::RemoveReceiverElement(const QString& output_name, MSElement& element)
{
  if (output_name.isEmpty())
  {
    MC_WARNING("The output name is not specified.");
    return;
  }
  for (auto iter = ReceiverElements.begin(); iter != ReceiverElements.end(); ++iter)
  {
    if (iter.key() == output_name && iter.value() == &element)
    {
      ReceiverElements.erase(iter);
      break;
    }
  }
}


MSData* MSElement::GetOutputData(const QString& output_name) const
{
  return OutputList[output_name];
}


void MSElement::SetInputData(const QString& input_name, const MSData& new_data)
{
  if (input_name.isEmpty())
  {
    MC_WARNING("The input name is not specified.");
    return;
  }
  if (!InputList.contains(input_name))
  {
    MC_WARNING("The input name (%s) is not in the input list.", qPrintable(input_name));
    return;
  }
  CurrentInputList += input_name;
  *InputList[input_name] = new_data;
}


void MSElement::Feeding()
{
  for (auto iter = ReceiverElements.begin(); iter != ReceiverElements.end(); ++iter)
  {
    if (CurrentOutputList.contains(iter.key()))
    {
      // Avoid the performance hit of this log message with huge
      // number of data connections
//      QString Message;
//
//      Message = GetClass()+" (ID"+QString::number((int)GetElementID())+") -> "+
//                iter.value()->GetClass()+" (ID"+
//                QString::number((int)iter.value()->GetElementID())+") - "+
//                iter.key();
//      MC_LOG( Message.toAscii().data());
      iter.value()->SetInputData(iter.key(), *OutputList[iter.key()]);
    }
  }
}