BaseMeasure.h

// BaseMeasure.h:
// --------------
//

#ifndef __IPSDKBASESHAPEANALYSIS_BASEMEASURE_H__
#define __IPSDKBASESHAPEANALYSIS_BASEMEASURE_H__

// suppression warnings
// warning C4251: 'boost::enable_shared_from_this<T>::weak_this_' : class 'boost::weak_ptr<T>' needs to have dll-interface to be used by clients of class 'boost::enable_shared_from_this<T>'
#pragma warning (push)
#pragma warning (disable : 4251)

#include <IPSDKBaseShapeAnalysis/IPSDKBaseShapeAnalysisExports.h>
#include <IPSDKBaseShapeAnalysis/Measure/MeasureTypes.h>
#include <IPSDKBaseShapeAnalysis/Measure/Result/MeasureResultTypes.h>
#include <IPSDKSerialization/Engine/BaseObjectWithSkeleton.h>
#include <IPSDKUtil/Tools/ProcessingResult.h>
#include <boost/enable_shared_from_this.hpp>

namespace ipsdk {
namespace shape {
namespace analysis {


class IPSDKBASESHAPEANALYSIS_API BaseMeasure : public BaseObjectWithSkeleton,
                                               public boost::enable_shared_from_this<BaseMeasure>
{
    // declare serial class
    IPSDK_DECLARE_ABSTRACT_SERIAL_WITH_COPY(IPSDKBaseShapeAnalysis, BaseMeasure)

    // friend class for protected members access
    friend class MeasureSet;
    friend class BaseMeasureInfo;

protected:
    BaseMeasure();

public:
    virtual ~BaseMeasure() = 0;

// methods
public:
    bool                                    isInit() const;

    const BaseMeasureInfo&                  getMeasureInfo() const;

    const std::string&                      getToolTip() const;

    const std::string&                      getDefaultName() const;

    const std::string&                      getMeasureName() const;

    bool                                    is2dMode() const;

    virtual bool                            isColorMsr() const = 0;

    //------------------------------------------------
    //------------------------------------------------

    eMsrProcessingPolicy                    getMsrProcessingPolicy() const;

    bool                                    is2dMsr() const;

    bool                                    is3dMsr() const;

    eMsrShapeRequirements                   getMsrShapeRequirements() const;

    bool                                    requiresRowIntersections() const;

    bool                                    requiresBoundaryApproximation() const;

    const GeometricCalibrationConstPtr&     getGeometricCalibration() const;

    ipReal32                                getCalibrationXScale() const; 
    ipReal32                                getCalibrationYScale() const;
    ipReal32                                getCalibrationZScale() const;

    std::string                             getMsrUnitStr() const;

    //------------------------------------------------
    //------------------------------------------------

    const eMsrProcessingStatus&             getMsrProcessingStatus() const;

    bool                                    hasMsrGlobalInfo() const;

    const MeasureGlobalInfo&                getMsrGlobalInfo() const;

    ipUInt64                                getNbColorPlans() const;

    ipUInt64                                getNbEntities() const;

    bool                                    isReadyToProcess() const;

    const BaseMeasureResult&                getMeasureResult() const;

protected:
    virtual MeasureResultPtr    startProcessingDerived(const ipUInt64 defaultNbColorPlans,
                                                       const ipUInt64 nbEntities,
                                                       const bool bForceNbColorPlans,
                                                       const bool bWithIgnoredFirstElement) = 0;

    virtual BoolResult          validateMsrParams(const DataItemConstPtr& pMeasureParams) const {return true;}

    const BaseMeasureResult&    accessMeasureResult() const;
    BaseMeasureResult&          accessMeasureResult();

    MeasureConstPtr             getDependency(const std::string& dependencyName) const;

    virtual bool                hasColorDependency() const;

    virtual void                endProcessingDerived() {}
    virtual void                endProcessingDerived(const geom::Shape2dConstVector& shape2dColl) {}
    virtual void                endProcessingDerived(const geom::Shape3dConstVector& shape3dColl) {}

    virtual void                copyAdditionalResults(const BaseMeasure& subMeasure) {}

    virtual void                clearProcessingDerived() {}

private:
    void                        init(const MeasureInfoConstPtr& pMeasureInfo);

    BoolResult                  startProcessing(const ipUInt64 nbColorPlans,
                                                const ipUInt64 nbEntities);

    void                        setMsrGlobalInfo(const MsrGlobalInfoConstPtr& pMsrGlobalInfo);

    MeasurePtr                  createSubMeasure(const ipUInt64 subDataStartOffset,
                                                 const ipUInt64 nbSubData) const;
    MeasurePtr                  createSubMeasure(const UInt64Vector& subDataIdxColl) const;

    void                        endProcessing(const geom::Shape2dConstVector& shape2dColl);

    void                        endProcessing(const geom::Shape3dConstVector& shape3dColl);

    void                        clearProcessing();

// attributes
private:
    MeasureInfoConstPtr     _pMeasureInfo;

    MeasureColl             _dependencyMsrColl;

    MsrGlobalInfoConstPtr   _pMsrGlobalInfo;

    MeasureResultPtr        _pMeasureResult;

    eMsrProcessingStatus    _msrProcessingStatus;
};


inline bool
BaseMeasure::isInit() const
{
    return _pMeasureInfo.get() != 0;
}


} // end of namespace analysis
} // end of namespace shape
} // end of namespace ipsdk

#pragma warning (pop)

#endif // __IPSDKBASESHAPEANALYSIS_BASEMEASURE_H__