ISFSArray.h

// ===================================================================
//
// Description      
//      Contains the definition of ISFSArray interface
//
// Revision history
//      Date            Description
//      30-Nov-2012     First version
//
// ===================================================================
#ifndef __ISFSArray__
#define __ISFSArray__

// Forward class declaration
namespace Sfs2X {
namespace Entities {
namespace Data {
    class ISFSArray;
}   // namespace Data
}   // namespace Entities
}   // namespace Sfs2X


#include "../../Util/ByteArray.h"
#include "SFSDataWrapper.h"
#include "ISFSObject.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::Util;

namespace Sfs2X {
namespace Entities {
namespace Data {

    class DLLImportExport ISFSArray
    {
    public:
        virtual bool Contains(boost::shared_ptr<void> obj) = 0;
        
        virtual boost::shared_ptr<void> GetElementAt(long int index) = 0;
        
        virtual boost::shared_ptr<SFSDataWrapper> GetWrappedElementAt(long int index) = 0;
        
        virtual boost::shared_ptr<void> RemoveElementAt(unsigned long int index) = 0;
        
        virtual long int Size() = 0;
        
        virtual boost::shared_ptr<ByteArray> ToBinary() = 0;
        
        virtual boost::shared_ptr<string> GetDump(bool format) = 0;

        virtual boost::shared_ptr<string> GetDump() = 0; // Default to true
        
        virtual boost::shared_ptr<string> GetHexDump() = 0;

        /*
        * :::::::::::::::::::::::::::::::::::::::::
        * Type setters
        * ::::::::::::::::::::::::::::::::::::::::: 
        */
        
        // Primitives
        virtual void AddNull() = 0;
        
        virtual void AddBool(boost::shared_ptr<bool> val) = 0;

        virtual void AddBool(bool val) = 0;

        virtual void AddByte(boost::shared_ptr<unsigned char> val) = 0;

        virtual void AddByte(unsigned char val) = 0;

        virtual void AddShort(boost::shared_ptr<short int> val) = 0;

        virtual void AddShort(short int val) = 0;

        virtual void AddInt(boost::shared_ptr<long int> val) = 0;

        virtual void AddInt(long int val) = 0;

        virtual void AddLong(boost::shared_ptr<long long> val) = 0;

        virtual void AddLong(long long val) = 0;

        virtual void AddFloat(boost::shared_ptr<float> val) = 0;

        virtual void AddFloat(float val) = 0;

        virtual void AddDouble(boost::shared_ptr<double> val) = 0;

        virtual void AddDouble(double val) = 0;

        virtual void AddUtfString(boost::shared_ptr<string> val) = 0;

        virtual void AddUtfString(string val) = 0;

        virtual void AddText(boost::shared_ptr<string> val) = 0;

        virtual void AddText(string val) = 0;

        virtual void AddBoolArray(boost::shared_ptr<vector<boost::shared_ptr<bool> > > val) = 0;
        
        virtual void AddByteArray(boost::shared_ptr<ByteArray> val) = 0;
        
        virtual void AddShortArray(boost::shared_ptr<vector<boost::shared_ptr<short int> > > val) = 0;
        
        virtual void AddIntArray(boost::shared_ptr<vector<boost::shared_ptr<long int> > > val) = 0;
        
        virtual void AddLongArray(boost::shared_ptr<vector<boost::shared_ptr<long long> > > val) = 0;
        
        virtual void AddFloatArray(boost::shared_ptr<vector<boost::shared_ptr<float> > > val) = 0;
        
        virtual void AddDoubleArray(boost::shared_ptr<vector<boost::shared_ptr<double> > > val) = 0;
        
        virtual void AddUtfStringArray(boost::shared_ptr<vector<boost::shared_ptr<string> > > val) = 0;

        virtual void AddSFSArray(boost::shared_ptr<ISFSArray> val) = 0;

        virtual void AddSFSObject(boost::shared_ptr<ISFSObject> val) = 0;

        virtual void AddClass(boost::shared_ptr<void> val) = 0;

        virtual void Add(boost::shared_ptr<SFSDataWrapper> val) = 0;
    
        /*
        * :::::::::::::::::::::::::::::::::::::::::
        * Type getters
        * ::::::::::::::::::::::::::::::::::::::::: 
        */

        virtual bool IsNull(unsigned long int index) = 0;

        virtual bool GetBool(unsigned long int index) = 0;
        
        virtual unsigned char GetByte(unsigned long int index) = 0;
        
        virtual short int GetShort(unsigned long int index) = 0;
        
        virtual long int GetInt(unsigned long int index) = 0;
        
        virtual long long GetLong(unsigned long int index) = 0;
        
        virtual float GetFloat(unsigned long int index) = 0;
        
        virtual double GetDouble(unsigned long int index) = 0;
        
        virtual boost::shared_ptr<string> GetUtfString(unsigned long int index) = 0;
        
        virtual boost::shared_ptr<string> GetText(unsigned long int index) = 0;

        virtual boost::shared_ptr<vector<bool> > GetBoolArray(unsigned long int index) = 0;
        
        virtual boost::shared_ptr<ByteArray> GetByteArray(unsigned long int index) = 0;
        
        virtual boost::shared_ptr<vector<short int> > GetShortArray(unsigned long int index) = 0;
        
        virtual boost::shared_ptr<vector<long int> > GetIntArray(unsigned long int index) = 0;
        
        virtual boost::shared_ptr<vector<long long> > GetLongArray(unsigned long int index) = 0;
        
        virtual boost::shared_ptr<vector<float> > GetFloatArray(unsigned long int index) = 0;
        
        virtual boost::shared_ptr<vector<double> > GetDoubleArray(unsigned long int index) = 0;
        
        virtual boost::shared_ptr<vector<string> > GetUtfStringArray(unsigned long int index) = 0;
        
        virtual boost::shared_ptr<ISFSArray> GetSFSArray(unsigned long int index) = 0;
        
        virtual boost::shared_ptr<ISFSObject> GetSFSObject(unsigned long int index) = 0;
        
        virtual boost::shared_ptr<void> GetClass(unsigned long int index) = 0;
    };

}   // namespace Data
}   // namespace Entities
}   // namespace Sfs2X

#endif