StaticParameterSplit.h

// StaticParameterSplit.h:
// -----------------------
//

#ifndef __IPSDKBASEPROCESSING_STATICPARAMETERSPLIT_H__
#define __IPSDKBASEPROCESSING_STATICPARAMETERSPLIT_H__

#include <IPSDKBaseProcessing/DataSplit/Static/BaseStaticSplit.h>
#include <boost/make_shared.hpp>

namespace ipsdk {
namespace processor {


template <typename TProcessor, typename TAttribute>
class StaticParameterSplit : public BaseStaticSplit
{
// predefined public types
public:
    typedef TProcessor ProcessorType;

    typedef TAttribute AttributeType;

    typedef typename TAttribute::StorageType ParameterType;

    typedef std::vector<ParameterType> ParameterColl;

    typedef boost::shared_ptr<const ParameterColl> ParameterCollConstPtr;

public:
    StaticParameterSplit();
    ~StaticParameterSplit();

// methods
public:
    eSplitStaticType    getSplitStaticType() const;

    const std::string&  getAttributeName() const;

    const std::string&  getAttributeToolTip() const;

    void                init(const ParameterCollConstPtr& pParameterColl);

protected:
    bool                checkProcessorType(const BaseProcessor& processor);

    BoolResult          processAttribute(BaseProcessor& processor,
                                         const ipUInt32 elementIdx,
                                         const core::BaseRequestOrigin& requestOrigin);

// attributes
protected:
    ParameterCollConstPtr        _pParameterColl;
};


template <typename TProcessor, typename TAttribute>
StaticParameterSplit<TProcessor, TAttribute>::StaticParameterSplit()
{

}

template <typename TProcessor, typename TAttribute>
StaticParameterSplit<TProcessor, TAttribute>::~StaticParameterSplit()
{

}

template <typename TProcessor, typename TAttribute>
inline eSplitStaticType
StaticParameterSplit<TProcessor, TAttribute>::getSplitStaticType() const
{
    return eSplitStaticType::eSST_Parameter;
}

template <typename TProcessor, typename TAttribute>
inline const std::string&
StaticParameterSplit<TProcessor, TAttribute>::getAttributeName() const
{
    return TAttribute::getObjectNameStr();
}

template <typename TProcessor, typename TAttribute>
inline const std::string&
StaticParameterSplit<TProcessor, TAttribute>::getAttributeToolTip() const
{
    return TAttribute::getToolTipStr();
}

template <typename TProcessor, typename TAttribute>
inline void
StaticParameterSplit<TProcessor, TAttribute>::init(const ParameterCollConstPtr& pParameterColl)
{
    // check for input shared pointer validity
    if (pParameterColl.get() == 0)
        throwNullInputSharedPtr();

    // retrieve associated number of parameters
    const ipUInt32 nbParams = static_cast<ipUInt32>(pParameterColl->size());

    // call of base class initialization method
    ElementsLocationInfo elementsLocationInfo;
    elementsLocationInfo.insertNonLocalized(ElementsRange(0, nbParams), 0);
    this->initBaseSplitted(elementsLocationInfo);

    // collection of elements associated to static split
    _pParameterColl = pParameterColl;
}

template <typename TProcessor, typename TAttribute>
inline bool
StaticParameterSplit<TProcessor, TAttribute>::checkProcessorType(const BaseProcessor& processor)
{
    // check for consistency between processor and attribute
    BOOST_STATIC_ASSERT_MSG((processor::ExistsAttribute<TAttribute, typename TProcessor::AttributesInfo>::g_bValue),
                            "This attribute is not part of processor class");

    return dynamic_cast<const TProcessor*>(&processor) != 0;
}

template <typename TProcessor, typename TAttribute>
inline BoolResult
StaticParameterSplit<TProcessor, TAttribute>::processAttribute(BaseProcessor& processor,
                                                               const ipUInt32 elementIdx,
                                                               const core::BaseRequestOrigin& requestOrigin)
{
    // cast of input processor object
    TProcessor& tProcessor = static_cast<TProcessor&>(processor);

    // update of processor attribute value
    tProcessor.TProcessor::template set<TAttribute>((*_pParameterColl)[elementIdx]);

    return true;
}


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

#endif // __IPSDKBASEPROCESSING_STATICPARAMETERSPLIT_H__