BasePlanIndexedAttribute.h

// BasePlanIndexedAttribute.h:
// ---------------------------
//

#ifndef __IPSDKIMAGEPROCESSING_BASEPLANINDEXEDATTRIBUTE_H__
#define __IPSDKIMAGEPROCESSING_BASEPLANINDEXEDATTRIBUTE_H__

// suppression warnings
// warning C4251: 'ipsdk::imaproc::BasePlanIndexedAttribute::_pPlanIndexedColl' : class 'boost::shared_ptr<T>' needs to have dll-interface to be used by clients of class 'ipsdk::imaproc::BasePlanIndexedAttribute'
#pragma warning (push)
#pragma warning (disable : 4251)

#include <IPSDKImageProcessing/Attribute/BaseImageProcessingAttribute.h>
#include <IPSDKImageProcessing/Attribute/PlanIndexed/PlanIndexedAttributeTypes.h>
#include <IPSDKBaseData/PlanIndex/PlanIndexedCollTypes.h>

namespace ipsdk {
namespace imaproc {


class IPSDKIMAGEPROCESSING_API BasePlanIndexedAttribute : public BaseImageProcessingAttribute
{
    // declare serial class
    IPSDK_DECLARE_ABSTRACT_SERIAL_WITHOUT_COPY(IPSDKImageProcessing, BasePlanIndexedAttribute)

// predefined public types
public:
    static const eImageProcessingAttributeType::domain g_imageProcessingAttributeType = eImageProcessingAttributeType::eIPAT_PlanIndexed;

protected:
    BasePlanIndexedAttribute();

public:
    virtual ~BasePlanIndexedAttribute() = 0;

// methods
public:
    eImageProcessingAttributeType   getImageProcessingAttributeType() const;

    const BasePlanIndexedColl&      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;

protected:
    void                        initBase(const PlanIndexedCollPtr& pPlanIndexedColl);

    PlanIndexedCollConstPtr     accessStorage() const;
    const PlanIndexedCollPtr&   accessStorage();

    void                        clearDerived();

// attributes
protected:
    PlanIndexedCollPtr  _pPlanIndexedColl;
};


inline eImageProcessingAttributeType
BasePlanIndexedAttribute::getImageProcessingAttributeType() const
{
    return g_imageProcessingAttributeType;
}


} // end of namespace imaproc
} // end of namespace ipsdk

#pragma warning (pop)

#endif // __IPSDKIMAGEPROCESSING_BASEPLANINDEXEDATTRIBUTE_H__