AttributeFactory.h

// AttributeFactory.h:
// -------------------
//

#ifndef __IPSDKBASEPROCESSING_ATTRIBUTEFACTORY_H__
#define __IPSDKBASEPROCESSING_ATTRIBUTEFACTORY_H__

// suppression warnings
// warning C4275: non dll-interface class 'boost::noncopyable_::noncopyable' used as base for dll-interface class 'ipsdk::processor::AttributeFactory'
// warning C4251: 'ipsdk::processor::AttributeFactory::_factoryMap' : class 'std::map<_Kty,_Ty>' needs to have dll-interface to be used by clients of class 'ipsdk::processor::AttributeFactory'
#pragma warning (push)
#pragma warning (disable : 4275 4251)

#include <IPSDKBaseProcessing/IPSDKBaseProcessingExports.h>
#include <IPSDKBaseProcessing/Attribute/Base/AttributeTypes.h>
#include <IPSDKUtil/BaseTypes.h>
#include <boost/noncopyable.hpp>
#include <map>
#include <set>

namespace ipsdk {
namespace processor {


class IPSDKBASEPROCESSING_API AttributeFactory : public boost::noncopyable
{
public:
    static AttributeFactory&    getInstance();

protected:
    AttributeFactory();
    ~AttributeFactory();

// methods
public:
    bool                            isRegistredAttribute(const std::string& className) const;

    std::set<std::string>           getRegistredAttributes() const;

    template <typename AttributeType>
    void                            registerAttribute();

    template <typename AttributeType>
    void                            unRegisterAttribute();

    const std::string&              getAttributeName(const std::string& className) const;

    const std::string&              getAttributeToolTip(const std::string& className) const;

    const std::string&              getAttributeLibraryName(const std::string& className) const;

    const boost::filesystem::path&  getAttributeHeaderPath(const std::string& className) const;

    AttributePtr                    createAttribute(const std::string& className) const;

protected:
    struct AttributeInfo
    {
        std::string             _attributeName;

        std::string             _attributeToolTip;

        std::string             _attributeLibraryName;

        boost::filesystem::path _attributeHeaderPath;

        AttributeCreator        _attributeCreator;
    };

    void                registerAttribute(const std::string& className,
                                          const AttributeInfo& attributeInfo);

    void                unRegisterAttribute(const std::string& className);

// attributes
protected:
    typedef std::map<std::string, AttributeInfo> FactoryMap;

    FactoryMap          _factoryMap;
};


template <typename AttributeType>
inline void
AttributeFactory::registerAttribute()
{
    // retrieve attribute class name
    const std::string& className = AttributeType::getTypeName();

    // create an attribute information structure
    AttributeInfo attributeInfo;
    attributeInfo._attributeName = AttributeType::getObjectNameStr();
    attributeInfo._attributeToolTip = AttributeType::getToolTipStr();
    attributeInfo._attributeLibraryName = AttributeType::getLibraryNameStr();
    attributeInfo._attributeHeaderPath = AttributeType::getHeaderPathStr();
    attributeInfo._attributeCreator = &AttributeType::createBaseAttribute;

    // register attribute into collection
    registerAttribute(className, attributeInfo);
}

template <typename AttributeType>
inline void
AttributeFactory::unRegisterAttribute()
{
    // retrieve attribute class name
    const std::string& className = AttributeType::getTypeName();

    // register attribute into collection
    unRegisterAttribute(className);
}


} // end of namespace processor
} // end of namespace ipsdk

#pragma warning (pop)

#endif // __IPSDKBASEPROCESSING_ATTRIBUTEFACTORY_H__