DataItemMap.h

// DataItemMap.h:
// --------------
//

#ifndef __IPSDKBASEDATA_DATAITEMMAP_H__
#define __IPSDKBASEDATA_DATAITEMMAP_H__

// suppression warnings
// warning C4251: 'ipsdk::DataItemMap::_itemMap' : class 'std::map<_Kty,_Ty>' needs to have dll-interface to be used by clients of class 'ipsdk::DataItemMap'
#pragma warning (push)
#pragma warning (disable : 4251)

#include <IPSDKBaseData/DataItem/BaseDataItem.h>
#include <map>

namespace ipsdk {


class IPSDKBASEDATA_API DataItemMap : public BaseDataItem
{
    // declare serial class
    IPSDK_DECLARE_SERIAL_WITH_COPY(IPSDKBaseData, DataItemMap)

// predefined public types
public:
    static const bool g_bIsColl = false;
    static const bool g_bNode = true;
    static const bool g_bLeaf = true;
    static const eDataItemType::domain g_itemType = eDataItemType::eDIT_Map;

    typedef std::map<std::string, DataItemPtr> MapType;

public:
    DataItemMap();
    ~DataItemMap();

// methods
public:
    eDataItemType       getDataItemType() const;

    const MapType&      getMap() const;

    ItemNames           getItemNames() const;

    bool                isEmpty() const;

    ipUInt32            getSize() const;

    bool                existsItem(const std::string& itemName) const;

    const BaseDataItem& getItem(const std::string& itemName) const;
    BaseDataItem&       getItem(const std::string& itemName);

    DataItemConstPtr    getItemPtr(const std::string& itemName) const;
    DataItemPtr         getItemPtr(const std::string& itemName);

    void                insertItem(const std::string& itemName,
                                   const DataItemPtr& pItem);

    void                removeItem(const std::string& itemName);

    void                clear();

// attributes
protected:
    MapType             _itemMap;
};


inline eDataItemType
DataItemMap::getDataItemType() const
{
    return g_itemType;
}

inline const DataItemMap::MapType&
DataItemMap::getMap() const
{
    return _itemMap;
}


} // end of namespace ipsdk

#pragma warning (pop)

#endif // __IPSDKBASEDATA_DATAITEMMAP_H__