PlanIndexedColl.h

// PlanIndexedColl.h:
// ------------------
//

#ifndef __IPSDKBASEDATA_PLANINDEXEDCOLL_H__
#define __IPSDKBASEDATA_PLANINDEXEDCOLL_H__

#include <IPSDKBaseData/PlanIndex/BasePlanIndexedColl.h>
#include <IPSDKSerialization/Engine/BaseObjectWithSkeleton.h>
#include <boost/type_traits/is_base_of.hpp>

namespace ipsdk {


template <typename T>
class PlanIndexedColl : public ipsdk::BasePlanIndexedColl
{
// predefined public types
public:
    // value type associated to objects into collection
    typedef T ValueType;

    // storage type associated to objects into collection
    typedef boost::shared_ptr<T> StorageType;

    // const storage type associated to objects into collection
    typedef boost::shared_ptr<const T> ConstStorageType;

public:
    PlanIndexedColl() {}
    ~PlanIndexedColl() {}

// methods
public:
    const std::string&  getElementsClassName() const;

    bool                haveSkeleton() const;

    // \brief insert a new element for a given plan index
    void                insert(const ipsdk::PlanIndex& planIndex,
                               const StorageType& pObject);

    // \brief insert a new element for a given plan index
    void                insert(const ipsdk::ipUInt64 zPlanIdx,
                               const ipsdk::ipUInt64 cPlanIdx,
                               const ipsdk::ipUInt64 tPlanIdx,
                               const StorageType& pObject);

    void                assign(const T& object,
                               const ipUInt64 sizeZ,
                               const ipUInt64 sizeC,
                               const ipUInt64 sizeT);

    ConstStorageType    getStorage(const ipsdk::PlanIndex& planIndex) const;

    ConstStorageType    getStorage(const ipsdk::ipUInt64 zPlanIdx,
                                   const ipsdk::ipUInt64 cPlanIdx,
                                   const ipsdk::ipUInt64 tPlanIdx) const;

    StorageType         getStorage(const ipsdk::PlanIndex& planIndex);

    StorageType         getStorage(const ipsdk::ipUInt64 zPlanIdx,
                                   const ipsdk::ipUInt64 cPlanIdx,
                                   const ipsdk::ipUInt64 tPlanIdx);

    const ValueType&    getValue(const ipsdk::PlanIndex& planIndex) const;

    const ValueType&    getValue(const ipsdk::ipUInt64 zPlanIdx,
                                 const ipsdk::ipUInt64 cPlanIdx,
                                 const ipsdk::ipUInt64 tPlanIdx) const;

    const ValueType&    getValue(const ipsdk::ipUInt64 planOffset) const;

    ValueType&          getValue(const ipsdk::PlanIndex& planIndex);

    ValueType&          getValue(const ipsdk::ipUInt64 zPlanIdx,
                                 const ipsdk::ipUInt64 cPlanIdx,
                                 const ipsdk::ipUInt64 tPlanIdx);

    ValueType&          getValue(const ipsdk::ipUInt64 planOffset);

// attributes
protected:

};


template <typename T>
inline const std::string&
PlanIndexedColl<T>::getElementsClassName() const
{
    return ValueType::getTypeName();
}

template <typename T>
inline bool
PlanIndexedColl<T>::haveSkeleton() const
{
    return boost::is_base_of<ipsdk::BaseObjectWithSkeleton, ValueType>::value;
}

template <typename T>
inline void
PlanIndexedColl<T>::insert(const ipsdk::PlanIndex& planIndex,
                           const StorageType& pObject)
{
    BasePlanIndexedColl::insert(planIndex, pObject);
}

template <typename T>
inline void
PlanIndexedColl<T>::insert(const ipsdk::ipUInt64 zPlanIdx,
                           const ipsdk::ipUInt64 cPlanIdx,
                           const ipsdk::ipUInt64 tPlanIdx,
                           const StorageType& pObject)
{
    insert(PlanIndex(zPlanIdx, cPlanIdx, tPlanIdx), pObject);
}

template <typename T>
inline void
PlanIndexedColl<T>::assign(const T& object,
                           const ipUInt64 sizeZ,
                           const ipUInt64 sizeC,
                           const ipUInt64 sizeT)
{
    BasePlanIndexedColl::assign(object, sizeZ, sizeC, sizeT);
}

template <typename T>
inline typename PlanIndexedColl<T>::ConstStorageType
PlanIndexedColl<T>::getStorage(const ipsdk::PlanIndex& planIndex) const
{
    return boost::static_pointer_cast<const ValueType>(BasePlanIndexedColl::getStorage(planIndex));
}

template <typename T>
inline typename PlanIndexedColl<T>::ConstStorageType
PlanIndexedColl<T>::getStorage(const ipsdk::ipUInt64 zPlanIdx,
                               const ipsdk::ipUInt64 cPlanIdx,
                               const ipsdk::ipUInt64 tPlanIdx) const
{
    return getStorage(PlanIndex(zPlanIdx, cPlanIdx, tPlanIdx));
}

template <typename T>
inline typename PlanIndexedColl<T>::StorageType
PlanIndexedColl<T>::getStorage(const ipsdk::PlanIndex& planIndex)
{
    return boost::static_pointer_cast<ValueType>(BasePlanIndexedColl::getStorage(planIndex));
}

template <typename T>
inline typename PlanIndexedColl<T>::StorageType
PlanIndexedColl<T>::getStorage(const ipsdk::ipUInt64 zPlanIdx,
                               const ipsdk::ipUInt64 cPlanIdx,
                               const ipsdk::ipUInt64 tPlanIdx)
{
    return getStorage(PlanIndex(zPlanIdx, cPlanIdx, tPlanIdx));
}

template <typename T>
inline const typename PlanIndexedColl<T>::ValueType&
PlanIndexedColl<T>::getValue(const ipsdk::PlanIndex& planIndex) const
{
    return static_cast<const ValueType&>(*getStorage(planIndex));
}

template <typename T>
inline const typename PlanIndexedColl<T>::ValueType&
PlanIndexedColl<T>::getValue(const ipsdk::ipUInt64 zPlanIdx,
                             const ipsdk::ipUInt64 cPlanIdx,
                             const ipsdk::ipUInt64 tPlanIdx) const
{
    return getValue(PlanIndex(zPlanIdx, cPlanIdx, tPlanIdx));
}

template <typename T>
inline const typename PlanIndexedColl<T>::ValueType&
PlanIndexedColl<T>::getValue(const ipsdk::ipUInt64 planOffset) const
{
    return getValue(BasePlanIndexedColl::getPlanIndex(planOffset));
}

template <typename T>
inline typename PlanIndexedColl<T>::ValueType&
PlanIndexedColl<T>::getValue(const ipsdk::PlanIndex& planIndex)
{
    return static_cast<ValueType&>(*getStorage(planIndex));
}

template <typename T>
inline typename PlanIndexedColl<T>::ValueType&
PlanIndexedColl<T>::getValue(const ipsdk::ipUInt64 zPlanIdx,
                             const ipsdk::ipUInt64 cPlanIdx,
                             const ipsdk::ipUInt64 tPlanIdx)
{
    return getValue(PlanIndex(zPlanIdx, cPlanIdx, tPlanIdx));
}

template <typename T>
inline typename PlanIndexedColl<T>::ValueType&
PlanIndexedColl<T>::getValue(const ipsdk::ipUInt64 planOffset)
{
    return getValue(BasePlanIndexedColl::getPlanIndex(planOffset));
}


} // end of namespace ipsdk

#endif // __IPSDKBASEDATA_PLANINDEXEDCOLL_H__