MeasureInfoSet.h

// MeasureInfoSet.h:
// -----------------
//

#ifndef __IPSDKBASESHAPEANALYSIS_MEASUREINFOSET_H__
#define __IPSDKBASESHAPEANALYSIS_MEASUREINFOSET_H__

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

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

namespace ipsdk {
namespace shape {
namespace analysis {


class IPSDKBASESHAPEANALYSIS_API MeasureInfoSet : public BaseSerializationObject,
                                                  public boost::enable_shared_from_this<MeasureInfoSet>
{
    // declare serial class
    IPSDK_DECLARE_SERIAL_WITHOUT_COPY(IPSDKBaseShapeAnalysis, MeasureInfoSet)

    // friend class for protected members access
    friend MeasureInfoSetPtr boost::make_shared<MeasureInfoSet>();
#if !defined( BOOST_NO_CXX11_RVALUE_REFERENCES )
    template< class T, class... Args >
    friend typename boost::detail::sp_if_not_array< T >::type boost::make_shared(Args && ...);
#else
    friend MeasureInfoSetPtr boost::make_shared<MeasureInfoSet, bool, ipsdk::GeometricCalibrationConstPtr>(const bool&, const ipsdk::GeometricCalibrationConstPtr&);
#endif

protected:
    MeasureInfoSet(const bool b2dMeasureSet = true,
                   const GeometricCalibrationConstPtr& pGlobalGeometricCalibration = GeometricCalibrationConstPtr());

public:
    ~MeasureInfoSet();

// methods
public:
    static MeasureInfoSetPtr            create2dInstance(const GeometricCalibrationConstPtr& pGlobalGeometricCalibration = GeometricCalibrationConstPtr());

    static MeasureInfoSetPtr            create3dInstance(const GeometricCalibrationConstPtr& pGlobalGeometricCalibration = GeometricCalibrationConstPtr());

    static MeasureInfoSetPtr            createFromExisting(const MeasureInfoSet& inputMeasureInfoSet);

    bool                                is2dMeasureSet() const;

    bool                                is3dMeasureSet() const;

    const GeometricCalibrationConstPtr& getGlobalGeometricCalibration() const;
    
    const MeasureInfoColl&              getMeasureInfoColl() const;

    void                                extractNeededInputs(ShapeCollIdSet& shapeCollIdSet,
                                                            ImageIdSet& imageIdSet) const;

    bool                                requiresRowIntersections(const eMsrInputShapeCollId& shapeCollId) const;

    bool                                requiresBoundaryApproximation(const eMsrInputShapeCollId& shapeCollId) const;

    const AliasMap&                     getAliasMap() const;

    bool                                existsMeasureInfo(const std::string& measureName,
                                                          const eMsrNameType& msrNameType = eMsrNameType::eMNT_User) const;

    bool                                existsMeasureInfo(const std::string& measureDefaultName,
                                                          const MeasureConfigConstPtr& pMeasureConfig,
                                                          const DataItemConstPtr& pMeasureParams) const;

    BoolResult                          createMeasureInfo(const std::string& measureName,
                                                          const std::string& measureDefaultName,
                                                          const DataItemConstPtr& pMeasureParams);
    BoolResult                          createMeasureInfo(const std::string& measureName,
                                                          const std::string& measureDefaultName,
                                                          const MeasureConfigConstPtr& pMeasureConfig = MeasureConfigConstPtr(),
                                                          const DataItemConstPtr& pMeasureParams = DataItemConstPtr());

    BoolResult                          createMeasureInfo(const std::string& measureDefaultName,
                                                          const DataItemConstPtr& pMeasureParams);
    BoolResult                          createMeasureInfo(const std::string& measureDefaultName,
                                                          const MeasureConfigConstPtr& pMeasureConfig = MeasureConfigConstPtr(),
                                                          const DataItemConstPtr& pMeasureParams = DataItemConstPtr());

    MeasureInfoConstPtr                 getMeasureInfo(const std::string& measureName) const;
    const MeasureInfoPtr&               getMeasureInfo(const std::string& measureName);

    void                                getMeasureInfoColl(const std::string& defaultMeasureName,
                                                           MeasureInfoColl& measureInfoColl) const;

    void                                clear();

// attributes
protected:
    bool                            _b2dMeasureSet;

    MeasureInfoColl                 _measureInfoColl;

    AliasMap                        _aliasMap;

    GeometricCalibrationConstPtr    _pGlobalGeometricCalibration;
};


inline bool
MeasureInfoSet::is2dMeasureSet() const
{
    return _b2dMeasureSet == true;
}

inline bool
MeasureInfoSet::is3dMeasureSet() const
{
    return _b2dMeasureSet == false;
}


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

#pragma warning (pop)

#endif // __IPSDKBASESHAPEANALYSIS_MEASUREINFOSET_H__