SFSUserVariable.h

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

#include "../../Util/Common.h"
#include "BaseVariable.h"
#include "UserVariable.h"
#include "VariableType.h"
#include "../Data/ISFSObject.h"
#include "../Data/ISFSArray.h"
#include "../Data/SFSArray.h"
#include "../Data/SFSObject.h"
#include "../../Exceptions/SFSError.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
using namespace std;                    // STL library: declare the STL namespace


using namespace Sfs2X::Entities::Data;
using namespace Sfs2X::Exceptions;

namespace Sfs2X {
namespace Entities {
namespace Variables {

    class DLLImportExport SFSUserVariable : public BaseVariable, public UserVariable
    {
    public:

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

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

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

        SFSUserVariable(string name, boost::shared_ptr<void> val, long int type);
        
        static boost::shared_ptr<SFSUserVariable> newPrivateVariable(string name, boost::shared_ptr<long int> val);
        static boost::shared_ptr<SFSUserVariable> newPrivateVariable(string name, boost::shared_ptr<unsigned long int> val);
        static boost::shared_ptr<SFSUserVariable> newPrivateVariable(string name, boost::shared_ptr<int> val);
        static boost::shared_ptr<SFSUserVariable> newPrivateVariable(string name, boost::shared_ptr<unsigned int> val);
        static boost::shared_ptr<SFSUserVariable> newPrivateVariable(string name, boost::shared_ptr<bool> val);
        static boost::shared_ptr<SFSUserVariable> newPrivateVariable(string name, boost::shared_ptr<double> val);
        static boost::shared_ptr<SFSUserVariable> newPrivateVariable(string name, boost::shared_ptr<string> val);
        static boost::shared_ptr<SFSUserVariable> newPrivateVariable(string name, boost::shared_ptr<SFSObject> val);
        static boost::shared_ptr<SFSUserVariable> newPrivateVariable(string name, boost::shared_ptr<SFSArray> val);

        virtual ~SFSUserVariable();

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

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

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

    protected:

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

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

    private:

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

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

        bool isPrivate;
    };

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

#endif