SFSRoomVariable.h

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

#include "../../Util/Common.h"
#include "BaseVariable.h"
#include "RoomVariable.h"
#include "../Data/ISFSArray.h"

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

using namespace Sfs2X::Entities::Data;

namespace Sfs2X {
namespace Entities {
namespace Variables {

    class DLLImportExport SFSRoomVariable : public BaseVariable, public RoomVariable
    {
    public:

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

        static boost::shared_ptr<RoomVariable> FromSFSArray(boost::shared_ptr<ISFSArray> sfsa);

        SFSRoomVariable(string name, boost::shared_ptr<long int> val);
        SFSRoomVariable(string name, boost::shared_ptr<unsigned long int> val);
        SFSRoomVariable(string name, boost::shared_ptr<int> val);
        SFSRoomVariable(string name, boost::shared_ptr<unsigned int> val);
        SFSRoomVariable(string name, boost::shared_ptr<bool> val);
        SFSRoomVariable(string name, boost::shared_ptr<double> val);
        SFSRoomVariable(string name, boost::shared_ptr<string> val);
        SFSRoomVariable(string name, boost::shared_ptr<SFSObject> val);
        SFSRoomVariable(string name, boost::shared_ptr<SFSArray> val);

        SFSRoomVariable(string name, boost::shared_ptr<void> val, long int type);

        virtual ~SFSRoomVariable();

        bool IsPrivate();
        void IsPrivate(bool value);

        bool IsPersistent();
        void IsPersistent(bool value);

        boost::shared_ptr<string> ToString();
        boost::shared_ptr<ISFSArray> ToSFSArray();

        boost::shared_ptr<string> Name();
        VariableType Type();
        boost::shared_ptr<void> Value();
        boost::shared_ptr<bool> GetBoolValue();
        boost::shared_ptr<long int> GetIntValue();
        boost::shared_ptr<double> GetDoubleValue();
        boost::shared_ptr<string> GetStringValue();
        boost::shared_ptr<ISFSObject> GetSFSObjectValue();
        boost::shared_ptr<ISFSArray> GetSFSArrayValue();
        bool IsNull();

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

    protected:

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

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

    private:

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

        // -------------------------------------------------------------------
        // Private members
        // -------------------------------------------------------------------

        bool isPersistent;
        bool isPrivate;
    };

}   // namespace Variables
}   // namespace Entities
}   // namespace Sfs2X

#endif