SFSUser.h

// ===================================================================
//
// Description      
//      Contains the definition of SFSUser
//
// Revision history
//      Date            Description
//      30-Nov-2012     First version
//
// ===================================================================
#ifndef __SFSUser__
#define __SFSUser__

#include "User.h"
#include "Data/Vec3D.h"

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

#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::Data;
using namespace Sfs2X::Entities::Managers;
using namespace Sfs2X::Entities::Variables;
using namespace Sfs2X::Exceptions;

namespace Sfs2X {
namespace Entities {

    class DLLImportExport SFSUser : public User, public boost::enable_shared_from_this<SFSUser>
    {
    public:

        // -------------------------------------------------------------------
        // Public methods
        // -------------------------------------------------------------------

        static boost::shared_ptr<User> FromSFSArray(boost::shared_ptr<ISFSArray> sfsa, boost::shared_ptr<Room> room);
        static boost::shared_ptr<User> FromSFSArray(boost::shared_ptr<ISFSArray> sfsa);

        SFSUser(long int id, string name);
        SFSUser(long int id, string name, bool isItMe);
        virtual ~SFSUser();

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

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

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

        long int PrivilegeId();

        void PrivilegeId(long int value);

        boost::shared_ptr<IUserManager> UserManager();

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

        boost::shared_ptr<Vec3D> AOIEntryPoint();

        void AOIEntryPoint(boost::shared_ptr<Vec3D> value);
        
        //--------------------------------------------------
        
        bool IsGuest();
        
        bool IsStandardUser();
        
        bool IsModerator();
                
        bool IsAdmin();
        
        bool IsPlayerInRoom(boost::shared_ptr<Room> room);

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

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

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

        boost::shared_ptr<string> ToString();

        // -------------------------------------------------------------------
        // Public members
        // -------------------------------------------------------------------

    protected:

        // -------------------------------------------------------------------
        // Protected methods
        // -------------------------------------------------------------------

        // -------------------------------------------------------------------
        // Protected members
        // -------------------------------------------------------------------

        long int id;
        long int privilegeId;
        boost::shared_ptr<string> name;
        bool isItMe;
        boost::shared_ptr<map<string, boost::shared_ptr<UserVariable> > > variables;
        boost::shared_ptr<map<string, boost::shared_ptr<void> > > properties;
        bool isModerator;
        boost::shared_ptr<map<long int, long int> > playerIdByRoomId;
        boost::shared_ptr<IUserManager> userManager;
        boost::shared_ptr<Vec3D> aoiEntryPoint;

    private:

        // -------------------------------------------------------------------
        // Private methods
        // -------------------------------------------------------------------

        void Init(long int id, string name, bool isItMe);
        void RemoveUserVariable(string varName);

        // -------------------------------------------------------------------
        // Private members
        // -------------------------------------------------------------------
    };

}   // namespace Entities
}   // namespace Sfs2X

#endif