IPSDK  4_1_0_2
IPSDK : Image Processing Software Development Kit
MeasureInfoUtils.h
Go to the documentation of this file.
1 // MeasureInfoUtils.h:
3 // -------------------
4 //
14 
15 #ifndef __IPSDKBASESHAPEANALYSIS_MEASUREINFOUTILS_H__
16 #define __IPSDKBASESHAPEANALYSIS_MEASUREINFOUTILS_H__
17 
20 #include <IPSDKUtil/BaseTypes.h>
22 
23 namespace ipsdk {
24 namespace shape {
25 namespace analysis {
26 
29 
36 createMeasureInfo(const MeasureInfoSetPtr& pMeasureInfoSet,
37  const std::string& measureName,
38  const std::string& measureDefaultName,
39  const MeasureConfigConstPtr& pMeasureConfig = MeasureConfigConstPtr(),
40  const DataItemConstPtr& pMeasureParams = DataItemConstPtr());
42 createMeasureInfo(const MeasureInfoSetPtr& pMeasureInfoSet,
43  const std::string& measureName,
44  const std::string& measureDefaultName,
45  const DataItemConstPtr& pMeasureParams);
47 createMeasureInfo(const MeasureInfoSetPtr& pMeasureInfoSet,
48  const std::string& measureDefaultName,
49  const MeasureConfigConstPtr& pMeasureConfig = MeasureConfigConstPtr(),
50  const DataItemConstPtr& pMeasureParams = DataItemConstPtr());
52 createMeasureInfo(const MeasureInfoSetPtr& pMeasureInfoSet,
53  const std::string& measureDefaultName,
54  const DataItemConstPtr& pMeasureParams);
56 
60 getDepencyUsedName(const std::string& measureName,
61  const std::string& dependencyName);
62 
65 isDepencyName(const std::string& measureName);
66 
70  const MeasureConfigConstPtr& pConfig2);
71 
74 compareMsrParams(const DataItemConstPtr& pMeasureParams1,
75  const DataItemConstPtr& pMeasureParams2);
76 
82 formatUnitStr(const std::string& baseUnitStr,
83  const eMsrUnitFormat& msrUnitFormat);
84 
87 formatUnitTimesUnit(const std::string& unitStr1,
88  const std::string& unitStr2);
89 
92 formatUnitDivUnit(const std::string& unitStr1,
93  const std::string& unitStr2);
94 
98 formatUnitPower(const std::string& unitStr,
99  const ipUInt32 power);
100 IPSDKBASESHAPEANALYSIS_API std::string
101 formatUnitPower(const std::string& unitStr,
102  const ipInt32 power);
104 
107 
108 } // end of namespace analysis
109 } // end of namespace shape
110 
120 
121 } // end of namespace ipsdk
122 
123 #endif // __IPSDKBASESHAPEANALYSIS_MEASUREINFOUTILS_H__
Main namespace for IPSDK library.
Definition: AlgorithmFunctionEfficiency.h:22
boost::shared_ptr< const MeasureConfig > MeasureConfigConstPtr
shared pointer to const MeasureConfig object
Definition: MeasureConfigTypes.h:89
boost::shared_ptr< const BaseDataItem > DataItemConstPtr
shared pointer to const DataItem
Definition: DataItemTypes.h:149
Forward declaration of serialization useful classes.
Definition of import/export macro for library.
int32_t ipInt32
Base types definition.
Definition: BaseTypes.h:52
IPSDKBASESHAPEANALYSIS_API std::string formatUnitStr(const std::string &baseUnitStr, const eMsrUnitFormat &msrUnitFormat)
function allowing to format measure unit from base length unit and from a format descriptor ...
#define IPSDKBASESHAPEANALYSIS_API
Import/Export macro for library IPSDKBaseShapeAnalysis.
Definition: IPSDKBaseShapeAnalysisExports.h:25
Base types for multiplatform compatibility.
Base class for serialization input archives.
Definition: BaseIArchive.h:36
Item used to format outputs during serialization.
Definition: DataItemNodeHdrMacrosDetails.h:37
IPSDKBASESHAPEANALYSIS_API std::string getDepencyUsedName(const std::string &measureName, const std::string &dependencyName)
eMsrUnitFormat
Enumerate describing unit format associated to measure.
Definition: MeasureInfoTypes.h:102
Predefined types for shape analysis measurement informations management.
IPSDKBASESHAPEANALYSIS_API bool compareMsrParams(const DataItemConstPtr &pMeasureParams1, const DataItemConstPtr &pMeasureParams2)
function allowing to compare measure parameters shared pointers
IPSDKBASESHAPEANALYSIS_API std::string formatUnitPower(const std::string &unitStr, const ipUInt32 power)
functions allowing to &#39;power&#39; a unit string by an integer
IPSDKBASESHAPEANALYSIS_API bool isDepencyName(const std::string &measureName)
function allowing to check whether a measure name is a dependency
Base class for serialization output archives.
Definition: BaseOArchive.h:35
IPSDKBASESHAPEANALYSIS_API void createMeasureInfo(const MeasureInfoSetPtr &pMeasureInfoSet, const std::string &measureName, const std::string &measureDefaultName, const MeasureConfigConstPtr &pMeasureConfig=MeasureConfigConstPtr(), const DataItemConstPtr &pMeasureParams=DataItemConstPtr())
functions allowing to create a new measure information and to insert it into a measure information se...
IPSDKBASESHAPEANALYSIS_API bool compareMsrConfig(const MeasureConfigConstPtr &pConfig1, const MeasureConfigConstPtr &pConfig2)
function allowing to compare measure primary configuration shared pointers
IPSDKBASESHAPEANALYSIS_API std::string formatUnitDivUnit(const std::string &unitStr1, const std::string &unitStr2)
function allowing to &#39;divide&#39; a unit string by an other
boost::shared_ptr< MeasureInfoSet > MeasureInfoSetPtr
shared pointer to shape measure information set
Definition: MeasureInfoTypes.h:157
Item used to format inputs during serialization.
Definition: DataItemNodeHdrMacrosDetails.h:42
IPSDKBASESHAPEANALYSIS_API ipsdk::BaseIArchive & operator>>(ipsdk::BaseIArchive &ar, const ipsdk::SerializationIItem< ipsdk::shape::analysis::MeasureId > &item)
serialization of ipsdk::shape::analysis::MeasureId structure
IPSDKBASESHAPEANALYSIS_API ipsdk::BaseOArchive & operator<<(ipsdk::BaseOArchive &ar, const ipsdk::SerializationOItem< ipsdk::shape::analysis::MeasureId > &item)
serialization of ipsdk::shape::analysis::MeasureId structure
IPSDKBASESHAPEANALYSIS_API std::string formatUnitTimesUnit(const std::string &unitStr1, const std::string &unitStr2)
function allowing to &#39;multiply&#39; two units string
uint32_t ipUInt32
Base types definition.
Definition: BaseTypes.h:53