SFSRoom.h

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

#include "Data/ISFSArray.h"
#include "Room.h"
#include "./Managers/IRoomManager.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 <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;
using namespace Sfs2X::Util;

namespace Sfs2X {
namespace Entities {

    class DLLImportExport SFSRoom : public Room, public boost::enable_shared_from_this<SFSRoom>
    {
    public:

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

        SFSRoom(long int id, string name);
        SFSRoom(long int id, string name, string groupId);
        virtual void Dispose();
        virtual ~SFSRoom();
        static boost::shared_ptr<Room> FromSFSArray(boost::shared_ptr<ISFSArray> sfsa);
        long int Id();

        boost::shared_ptr<string> Name();

        void Name(string value);

        boost::shared_ptr<string> GroupId();

        bool IsGame();

        void IsGame(bool value);

        bool IsHidden();

        void IsHidden(bool value);

        bool IsJoined();

        void IsJoined(bool value);

        bool IsPasswordProtected();

        void IsPasswordProtected(bool value);

        bool IsManaged();

        void IsManaged(bool value);

        long int MaxSpectators();
        void MaxSpectators(long int value);

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

        boost::shared_ptr<vector<boost::shared_ptr<RoomVariable> > > GetVariables();

        boost::shared_ptr<RoomVariable> GetVariable(string name);

        long int UserCount();

        void UserCount(long int value);

        long int MaxUsers();

        void MaxUsers(long int value);

        long int Capacity();

        long int SpectatorCount();

        void SpectatorCount(long int value);

        boost::shared_ptr<User> GetUserByName(string name);

        boost::shared_ptr<User> GetUserById(long int id);

        boost::shared_ptr<vector<boost::shared_ptr<User> > > UserList();

        boost::shared_ptr<vector<boost::shared_ptr<User> > > PlayerList();

        boost::shared_ptr<vector<boost::shared_ptr<User> > > SpectatorList();

        void RemoveUser(boost::shared_ptr<User> user);

        void SetVariable(boost::shared_ptr<RoomVariable> roomVariable);

        void SetVariables(boost::shared_ptr<vector<boost::shared_ptr<RoomVariable> > > roomVariables);

        bool ContainsVariable(string name);

        void AddUser(boost::shared_ptr<User> user);

        bool ContainsUser(boost::shared_ptr<User> user);

        boost::shared_ptr<IRoomManager> RoomManager();
        void RoomManager(boost::shared_ptr<IRoomManager> value);

        boost::shared_ptr<string> ToString();

        void Merge(boost::shared_ptr<Room> anotherRoom);

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

    protected:

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

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

        long int id;
        boost::shared_ptr<string> name;
        boost::shared_ptr<string> groupId;
        bool isGame;
        bool isHidden;
        bool isJoined;
        bool isPasswordProtected;
        bool isManaged;
        boost::shared_ptr<map<string, boost::shared_ptr<RoomVariable> > > variables;
        boost::shared_ptr<map<string, string> > properties;
        boost::shared_ptr<IUserManager> userManager;
        long int maxUsers;
        long int maxSpectators;
        long int userCount;                 // only for non joined rooms
        long int specCount;                 // only for non joined rooms
        boost::shared_ptr<IRoomManager> roomManager;

    private:

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

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

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

}   // namespace Entities
}   // namespace Sfs2X

#endif