User.h

// ===================================================================
//
// Description      
//      Contains the definition of User interface
//
// Revision history
//      Date            Description
//      30-Nov-2012     First version
//
// ===================================================================
#ifndef __User__
#define __User__

namespace Sfs2X {
namespace Entities {
    class User;
}   // namespace Entities
}   // namespace Sfs2X

#include "../Util/Common.h"
#include "Variables/UserVariable.h"
#include "Managers/IUserManager.h"
#include "Room.h"
#include "Data/Vec3D.h"

#include <boost/shared_ptr.hpp>             // Boost Asio shared pointer

using namespace Sfs2X::Entities::Managers;
using namespace Sfs2X::Entities::Data;
using namespace Sfs2X::Entities::Variables;

#if defined(_MSC_VER)
#pragma warning(disable:4786)           // STL library: disable warning 4786; this warning is generated due to a Microsoft bug
#endif
#include <string>                       // STL library: string object 
#include <list>                         // STL library: list object
#include <vector>                       // STL library: vector object
#include <map>                          // STL library: map object
using namespace std;                    // STL library: declare the STL namespace

using namespace Sfs2X::Entities::Variables;

namespace Sfs2X {
namespace Entities {

    class DLLImportExport User
    {
    public:

        virtual long int Id() = 0;
        
        virtual boost::shared_ptr<string> Name() = 0;

        virtual long int PlayerId() = 0;
        
        virtual bool IsPlayer() = 0;
        
        virtual bool IsSpectator() = 0;
        
        virtual long int GetPlayerId (boost::shared_ptr<Room> room) = 0;

        virtual void SetPlayerId(long int id, boost::shared_ptr<Room> room) = 0;
        
        virtual void RemovePlayerId(boost::shared_ptr<Room> room) = 0;

        virtual long int PrivilegeId() = 0;

        virtual void PrivilegeId(long int value) = 0;

        virtual boost::shared_ptr<IUserManager> UserManager() = 0;

        virtual void UserManager(boost::shared_ptr<IUserManager> value) = 0;

        //--------------------------------------------------
        
        virtual bool IsGuest() = 0;
        
        virtual bool IsStandardUser() = 0;
        
        virtual bool IsModerator() = 0;
                
        virtual bool IsAdmin() = 0;
        //--------------------------------------------------
        
        virtual bool IsPlayerInRoom(boost::shared_ptr<Room> room) = 0;

        virtual bool IsSpectatorInRoom(boost::shared_ptr<Room> room) = 0;

        virtual bool IsJoinedInRoom(boost::shared_ptr<Room> room) = 0;
        
        virtual bool IsItMe() = 0;
        
        virtual boost::shared_ptr<vector<boost::shared_ptr<UserVariable> > > GetVariables() = 0;
        
        virtual boost::shared_ptr<UserVariable> GetVariable(string varName) = 0;
        
        virtual void SetVariable(boost::shared_ptr<UserVariable> userVariable) = 0;
        
        virtual void SetVariables(boost::shared_ptr<vector<boost::shared_ptr<UserVariable> > > userVaribles) = 0;
        
        virtual bool ContainsVariable(string name) = 0;
        
        virtual boost::shared_ptr<map<string, boost::shared_ptr<void> > > Properties() = 0;

        virtual void Properties(boost::shared_ptr<map<string, boost::shared_ptr<void> > > value) = 0;

        virtual boost::shared_ptr<Vec3D> AOIEntryPoint() = 0;

        virtual void AOIEntryPoint(boost::shared_ptr<Vec3D>value) = 0;
    };

}   // namespace Entities
}   // namespace Sfs2X

#endif