BasePlanIndexedColl.h

// BasePlanIndexedColl.h:
// ----------------------
//

#ifndef __IPSDKBASEDATA_BASEPLANINDEXEDCOLL_H__
#define __IPSDKBASEDATA_BASEPLANINDEXEDCOLL_H__

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

#include <IPSDKBaseData/IPSDKBaseDataExports.h>
#include <IPSDKBaseData/PlanIndex/PlanIndex.h>
#include <IPSDKBaseData/PlanIndex/PlanIndexedCollTypes.h>
#include <IPSDKSerialization/Engine/BaseObjectWithSkeleton.h>
#include <map>

namespace ipsdk {


class IPSDKBASEDATA_API BasePlanIndexedColl : public BaseObjectWithSkeleton
{
    // declare serial class
    IPSDK_DECLARE_ABSTRACT_SERIAL_WITHOUT_COPY(IPSDKBaseData, BasePlanIndexedColl)

// predefined public types
public:
    typedef std::map<PlanIndex, SerializationObjectPtr> PlanIndexedColl;

    typedef std::map<PlanIndex, SerializationObjectConstPtr> PlanIndexedConstColl;

public:
    BasePlanIndexedColl();
    virtual ~BasePlanIndexedColl() = 0;

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

    virtual bool                haveSkeleton() const = 0;

    const PlanIndexedConstColl& getBaseColl() const;

    ipUInt64                    getNbPlans() const;

    ipUInt64                    getMaxSizeZ() const;
    ipUInt64                    getMaxSizeC() const;
    ipUInt64                    getMaxSizeT() const;

    bool                        exists(const PlanIndex& planIndex) const;
    bool                        exists(const ipUInt64 zPlanIdx,
                                       const ipUInt64 cPlanIdx,
                                       const ipUInt64 tPlanIdx) const;

    bool                        isComplete() const;

    bool                        isComplete(const ipUInt64 sizeZ,
                                           const ipUInt64 sizeC,
                                           const ipUInt64 sizeT) const;

    const PlanIndex&            getPlanIndex(const ipUInt64 planOffset) const;

    void                        clear();

protected:
    void                                insert(const PlanIndex& planIndex,
                                               const SerializationObjectPtr& pObject);

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

    SerializationObjectConstPtr         getStorage(const PlanIndex& planIndex) const;
    const SerializationObjectPtr&       getStorage(const PlanIndex& planIndex);

// attributes
protected:
    PlanIndexedColl     _planIndexedColl;
};


} // end of namespace ipsdk

#pragma warning (pop)

#endif // __IPSDKBASEDATA_BASEPLANINDEXEDCOLL_H__