BaseMeasureInfo.h

// BaseMeasureInfo.h:
// ------------------
//

#ifndef __IPSDKBASESHAPEANALYSIS_BASEMEASUREINFO_H__
#define __IPSDKBASESHAPEANALYSIS_BASEMEASUREINFO_H__

// suppression warnings
// warning C4251: 'ipsdk::shape::analysis::BaseMeasureInfo::_measureName' : class 'std::basic_string<_Elem,_Traits,_Alloc>' needs to have dll-interface to be used by clients of class 'ipsdk::shape::analysis::BaseMeasureInfo'
#pragma warning (push)
#pragma warning (disable : 4251)

#include <IPSDKBaseShapeAnalysis/IPSDKBaseShapeAnalysisExports.h>
#include <IPSDKBaseShapeAnalysis/Measure/MeasureTypes.h>
#include <IPSDKBaseData/ToolTip/BaseToolTip.h>
#include <IPSDKBaseData/Calibration/GeometricCalibrationTypes.h>
#include <IPSDKSerialization/Engine/BaseSerializationObject.h>
#include <IPSDKUtil/Tools/ProcessingResult.h>
#include <boost/enable_shared_from_this.hpp>
#include <boost/optional.hpp>

namespace ipsdk {
namespace shape {
namespace analysis {


class IPSDKBASESHAPEANALYSIS_API BaseMeasureInfo : public BaseSerializationObject,
                                                   public BaseToolTip,
                                                   public boost::enable_shared_from_this<BaseMeasureInfo>
{
    // declare serial class
    IPSDK_DECLARE_ABSTRACT_SERIAL_WITHOUT_COPY(IPSDKBaseShapeAnalysis, BaseMeasureInfo)

    // friend class for protected members access
    friend class MeasureInfoFactory;

protected:
    BaseMeasureInfo();

public:
    virtual ~BaseMeasureInfo() = 0;

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

    bool                                    isInit() const;

    const std::string&                      getMeasureName() const;

    bool                                    is2dMode() const;

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

    virtual eMsrProcessingPolicy            getMsrProcessingPolicy() const = 0;

    eMsrVolumePolicy                        getMsrVolumePolicy() const;

    bool                                    is2dMsr() const;

    bool                                    is3dMsr() const;

    virtual bool                            requiresInputImage() const {return false;}

    virtual eMsrShapeRequirements           getMsrShapeRequirements() const = 0;

    inline bool                             requiresRowIntersections() const;

    inline bool                             requiresBoundaryApproximation() const;

    //------------------------------------------------
    //------------------------------------------------
    
    const GeometricCalibrationConstPtr&     getGeometricCalibration() const;

    virtual eMsrUnitFormat                  getMsrUnitFormat() const = 0;

    std::string                             getMsrUnitStr() const;

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

    MeasureConfigConstPtr                   getMsrConfig() const;

    bool                                    hasDefaultConfig() const;

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

    virtual DataItemPtr                     createDefaultParams() const {return DataItemPtr();}

    bool                                    hasDefaultParams() const;

    bool                                    hasParams(const MeasureConfigConstPtr& pConfig,
                                                      const DataItemConstPtr& pParams) const;

    DataItemConstPtr                        getMsrParams() const;

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

    bool                                    dependsOnNamedMsr(const std::string& dependencyName) const;

    bool                                    dependsOn(const std::string& dependencyDefaultName) const;

    bool                                    dependsOn(const std::string& dependencyDefaultName,
                                                      const MeasureConfigConstPtr& pDependencyConfig,
                                                      const DataItemConstPtr& pDependencyParams) const;

    MeasureConfigConstPtr                   getDependencyConfig(const std::string& dependencyName) const;

    DataItemConstPtr                        getDependencyParams(const std::string& dependencyName) const;

    const DependencyMap&                    getDependencies() const;

    MeasurePtr                              createMeasure() const;

protected:
    virtual MeasurePtr              createMeasureDerived() const = 0;

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

    virtual void                    initDerived() = 0;

    virtual std::string             computeCustomMsrUnitStr(const std::string& baseUnitStr) const {return std::string();}

    virtual void                    createDependencies(const bool b2dMsrMode) = 0;

    virtual void                    createCustomDependencies(const bool b2dMsrMode) {}

    void                            addDependency(const std::string& dependencyDefaultName);

    void                            addDependency(const std::string& dependencyName,
                                                  const std::string& dependencyDefaultName,
                                                  const MeasureConfigConstPtr& pDependencyConfig,
                                                  const DataItemConstPtr& pDependencyParams);

    void                            addNamedMsrDependency(const std::string& dependencyName);

private:
    BoolResult                      init(const std::string& measureName,
                                         const bool b2dMsrMode,
                                         const GeometricCalibrationConstPtr& pGlobalGeometricCalibration,
                                         const MeasureConfigConstPtr& pMeasureConfig = MeasureConfigConstPtr(),
                                         const DataItemConstPtr& pMeasureParams = DataItemPtr());

// attributes
private:
    std::string                     _measureName;

    bool                            _b2dMsrMode;

    GeometricCalibrationConstPtr    _pGeometricCalibration;

    MeasureConfigConstPtr           _pMeasureConfig;

    DataItemPtr                     _pMeasureParams;

    DependencyMap                   _dependencies;
};


inline bool
BaseMeasureInfo::isInit() const
{
    return _measureName.empty() == false;
}

inline bool
BaseMeasureInfo::requiresRowIntersections() const
{
    const eMsrShapeRequirements& msrShapeRequirements = getMsrShapeRequirements();
    return msrShapeRequirements == eMsrShapeRequirements::eMSR_RequireShapeRowIntersect ||
           msrShapeRequirements == eMsrShapeRequirements::eMSR_RequireShapeAll;
}

inline bool
BaseMeasureInfo::requiresBoundaryApproximation() const
{
    const eMsrShapeRequirements& msrShapeRequirements = getMsrShapeRequirements();
    return msrShapeRequirements == eMsrShapeRequirements::eMSR_RequireShapeBoundaryApprox ||
           msrShapeRequirements == eMsrShapeRequirements::eMSR_RequireShapeAll;
}


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

#pragma warning (pop)

#endif // __IPSDKBASESHAPEANALYSIS_BASEMEASUREINFO_H__