RoomSettings.h

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

#include "../Util/Common.h"
#include "RoomPermissions.h"
#include "RoomEvents.h"
#include "RoomExtension.h"
#include "../Entities/Variables/RoomVariable.h"
#include "../Entities/SFSConstants.h"

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

#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 <vector>                       // STL library: vector object
using namespace std;                    // STL library: declare the STL namespace

using namespace Sfs2X;
using namespace Sfs2X::Entities;
using namespace Sfs2X::Entities::Variables;

namespace Sfs2X {
namespace Requests {

    class DLLImportExport RoomSettings
    {
    public:

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

        RoomSettings(string name);

        virtual ~RoomSettings();

        boost::shared_ptr<string> Name();

        void Name(string value);

        boost::shared_ptr<string> Password();

        void Password(string value);

        bool IsGame();

        void IsGame(bool value);

        short int MaxUsers();

        void MaxUsers(short int value);

        short int MaxVariables();

        void MaxVariables(short int value);

        short int MaxSpectators();

        void MaxSpectators(short int value);

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

        void Variables(boost::shared_ptr<vector<boost::shared_ptr<RoomVariable> > > value);

        boost::shared_ptr<RoomPermissions> Permissions();

        void Permissions(boost::shared_ptr<RoomPermissions> value);

        boost::shared_ptr<RoomEvents> Events();

        void Events(boost::shared_ptr<RoomEvents> value);

        boost::shared_ptr<RoomExtension> Extension();

        void Extension(boost::shared_ptr<RoomExtension> value);

        boost::shared_ptr<string> GroupId();

        void GroupId(string value);

        bool AllowOwnerOnlyInvitation();

        void AllowOwnerOnlyInvitation(bool value);

        // -------------------------------------------------------------------
        // Public members
        // -------------------------------------------------------------------
        
    protected:

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

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

    private:

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

        // -------------------------------------------------------------------
        // Private members
        // -------------------------------------------------------------------
        boost::shared_ptr<string> name;
        boost::shared_ptr<string> password;
        boost::shared_ptr<string> groupId;
        bool isGame;
        short int maxUsers;
        short int maxSpectators;
        short int maxVariables;
        boost::shared_ptr<vector<boost::shared_ptr<RoomVariable> > > variables;
        boost::shared_ptr<RoomPermissions> permissions;
        boost::shared_ptr<RoomEvents> events;
        boost::shared_ptr<RoomExtension> extension; 
        bool allowOwnerOnlyInvitation; // New in SFS2X 2.12
    };

}   // namespace Requests
}   // namespace Sfs2X

#endif