MSSessionStorage.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 "MSSessionStorageInterface.hpp"

#include <MCDataContainer.hpp>
#include <MCDataStorage.hpp>

#include <qmap.h>
#include <qobject.h>
#include <qpointer.h>
#include <qstring.h>
#include <qstringlist.h>
#include <QTime>
#include <qvector.h>

#include <boost/scoped_ptr.hpp>

class QSqlDatabase;
class MSElement;

// cppcheck-suppress noConstructor
class MSSessionStorage : public QObject
{
  Q_OBJECT
  Q_DISABLE_COPY(MSSessionStorage)

  
  MSSessionStorage();
public:
  ~MSSessionStorage();

  static MSSessionStorage* GetInstance();

  QString GetPlaybackPath() const;

  void SetPlaybackPath(const QString& path);

  QString GetRecordPath() const;

  void SetRecordPath(const QString& record_path);

  bool IsStorageAvailable() const;

  int GetPlayedHeartBeats() const;

  /*
  -------------------------------------------------------------------
                        General functions
  -------------------------------------------------------------------
  */

public Q_SLOTS:

  void BeatEnd(int beat_id);

public:

  void RegisterStorage(MSSessionStorageInterface& storage);

  void RemoveStorages();

  void ResetTimers();

  void RegisterElement(MSElement& object);

  void PrepareRecord();

  void PreparePlay();

  void Finalize();

private:

  QString ConstructFileName(int object_id, int beat_id,
                            const QString& base_path,
                            const QString& output_name,
                            const MSSessionStorageInterface::StorageDataType& storage_type) const;

  void CreateRecordDatabase();

  void CreateTableForAClass(MSElement& object);

  void LoadStatesFromDatabase();

  void RecordStatesToDatabase();

  MSSessionStorageInterface* GetStorage(const QString& type_name) const;

  QString ExecuteSqlQuery(const QSqlDatabase& database, const QString& query_str) const;

  void CloseRecordDatabase();

  void OpenPlaybackDatabase();

  void ClosePlaybackDatabase();

  void CreateRecordStorage();

  void CreateNewDataItemsForAClass(MSElement& object);

  void LoadStatesFromStorage();

  void RecordStatesToStorage();

  void CloseRecordStorage();

  void OpenPlaybackStorage();

  void ClosePlaybackStorage();

Q_SIGNALS:

  void EndOfDatabase();

private:
  QList<QPointer<MSSessionStorageInterface> > SessionStorages;
  QString PlaybackPath;
  QString RecordPath;
  boost::scoped_ptr<QSqlDatabase> PlaybackDatabase;
  boost::scoped_ptr<QSqlDatabase> RecordDatabase;
  boost::scoped_ptr<MCDataStorage> PlaybackStorage;
  boost::scoped_ptr<MCDataStorage> RecordStorage;
  const int RecordStoragePeriod;
  // Re-mapped source element IDs
  QMap<int, int> RemappedIDs;
  QMap<QString, QStringList> TableColumns;
  QStringList ElementClassNames;
  QList<MSElement*> RegElements;
  int PlayedHeartBeats;
};