SFSBuddy.h

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

#include "Data/ISFSArray.h"
#include "Buddy.h"
#include "Variables/BuddyVariable.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
#include <map>                          // STL library: map object
using namespace std;                    // STL library: declare the STL namespace

namespace Sfs2X {
namespace Entities {

    class DLLImportExport SFSBuddy : public Buddy
    {
    public:

        // -------------------------------------------------------------------
        // Public methods
        // -------------------------------------------------------------------
        static boost::shared_ptr<Buddy> FromSFSArray(boost::shared_ptr<ISFSArray> arr);

        SFSBuddy(long int id, string name);
        SFSBuddy(long int id, string name, bool isBlocked);
        SFSBuddy(long int id, string name, bool isBlocked, bool isTemp);
        virtual ~SFSBuddy();

        long int Id();
        void Id(long int value);
        bool IsBlocked();
        void IsBlocked(bool value);
        bool IsTemp();
        boost::shared_ptr<string> Name();
        bool IsOnline();
        boost::shared_ptr<string> State();
        boost::shared_ptr<string> NickName();
        boost::shared_ptr<vector<boost::shared_ptr<BuddyVariable> > > Variables();
        boost::shared_ptr<BuddyVariable> GetVariable(string varName);
        boost::shared_ptr<vector<boost::shared_ptr<BuddyVariable> > > GetOfflineVariables();
        boost::shared_ptr<vector<boost::shared_ptr<BuddyVariable> > > GetOnlineVariables();
        bool ContainsVariable(string varName);
        void SetVariable(boost::shared_ptr<BuddyVariable> bVar);
        void SetVariables(boost::shared_ptr<vector<boost::shared_ptr<BuddyVariable> > > variables);
        void RemoveVariable(string varName);
        void ClearVolatileVariables();
        boost::shared_ptr<string> ToString();

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

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

        // -------------------------------------------------------------------
        // Protected members
        // -------------------------------------------------------------------
        boost::shared_ptr<string> name;
        long int id;
        bool isBlocked;
        boost::shared_ptr<map<string, boost::shared_ptr<BuddyVariable> > > variables;
        bool isTemp;

    private:

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

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

}   // namespace Entities
}   // namespace Sfs2X

#endif