cyphesis/tools/EntityImporter.h
2013-11-19 21:54:40 +01:00

95 lines
2.8 KiB
C++

//
// Copyright (C) 2009 Alistair Riddoch
// Copyright (C) 2012 Erik Ogenvik
//
// This program 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.
//
// This program 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
//
#ifndef ENTITY_IMPORTER_H
#define ENTITY_IMPORTER_H
#include "EntityImporterBase.h"
#include "common/ClientTask.h"
#include <Atlas/Objects/Root.h>
#include <Atlas/Objects/RootOperation.h>
#include <Atlas/Objects/SmartPtr.h>
#include <unordered_map>
/**
* @brief Imports a previously exported entity.
*/
class EntityImporter: public ClientTask, public EntityImporterBase
{
public:
explicit EntityImporter(const std::string & accountId,
const std::string & avatarId);
virtual ~EntityImporter();
protected:
/**
* Keeps track of the current OpVector in which operations to be
* sent can be placed.
*
* Note that this setup is a little unintuitive. This is because the
* EntityExporterBase class is written for Ember which has a slightly
* different way of dispatching ops.
* The way we need to do it is to act on the setup() and operation()
* methods and while in those methods set this field to point to the
* current OpVector.
*
*/
OpVector* mCurrentRes;
std::unordered_map<long int, CallbackFunction> mCallbacks;
virtual void setup(const std::string & arg, OpVector & ret);
virtual void operation(const Operation & op, OpVector & res);
/**
* @brief Create a new unique serial number for operations.
* @return A new serial number.
*/
virtual long int newSerialNumber();
/**
* @brief Send an object to the server.
* @param op An object which is to be sent.
*/
virtual void send(const Atlas::Objects::Operation::RootOperation& op);
/**
* @brief Send an object to the server and await a response.
* @param op An object which is to be sent.
* @param callback A callback, called when a response is received.
*/
virtual void sendAndAwaitResponse(const Atlas::Objects::Operation::RootOperation& op, CallbackFunction& callback);
/**
* @brief Loads from a file.
* @param filename The full path to the file.
* @return The top level object stored in the file.
*/
virtual Atlas::Objects::Root loadFromFile(const std::string& filename);
void completed();
};
#endif // ENTITY_IMPORTER_H