BaseDataItemNode.h

// BaseDataItemNode.h:
// -------------------
//

#ifndef __IPSDKBASEDATA_BASEDATAITEMNODE_H__
#define __IPSDKBASEDATA_BASEDATAITEMNODE_H__

#include <IPSDKBaseData/DataItem/BaseDataItem.h>
#include <IPSDKBaseData/ToolTip/BaseToolTip.h>
#include <boost/shared_ptr.hpp>

namespace ipsdk {

class DataItemNodeFactory;


class IPSDKBASEDATA_API BaseDataItemNode : public BaseDataItem,
                                           public BaseToolTip
{
    // declare serial class
    IPSDK_DECLARE_ABSTRACT_SERIAL_WITH_COPY(IPSDKBaseData, BaseDataItemNode)

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

protected:
    BaseDataItemNode();

public:
    virtual ~BaseDataItemNode() = 0;

// methods
public:
    eDataItemType                           getDataItemType() const;

    virtual const boost::filesystem::path   getHeaderPath() const = 0;

    virtual const std::string               getLibraryName() const = 0;

    virtual const ItemNames&                getItemIds() const = 0;

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

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

    const std::string&                      getItemName(const std::string& itemId) const;

    const std::string&                      getItemToolTip(const std::string& itemId) const;

protected:
    template <typename T>
    struct NodeAccessor {

        T   _node;
    };

    struct ItemInfoStr {

        ItemInfoStr(const std::string& itemName,
                    const std::string& itemToolTip) :
            _itemName(itemName),
            _itemToolTip(itemToolTip)
        {}

        const std::string&  _itemName;

        const std::string&  _itemToolTip;
    };

    struct ItemInfo {

        ItemInfo(const BaseDataItem& item,
                 const std::string& itemName,
                 const std::string& itemToolTip) :
            _item(item),
            _itemName(itemName),
            _itemToolTip(itemToolTip)
        {}

        const BaseDataItem& _item;

        const std::string&  _itemName;

        const std::string&  _itemToolTip;
    };

    typedef boost::shared_ptr<ItemInfo> ItemInfoPtr;

    virtual ItemInfoPtr         getItemInfo(const std::string& itemId) const = 0;

// attributes
protected:

};


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


} // end of namespace ipsdk

#endif // __IPSDKBASEDATA_BASEDATAITEMNODE_H__