Object allowing to agregate a collection of measure informations. More...

#include <MeasureInfoSet.h>

Inheritance diagram for ipsdk::shape::analysis::MeasureInfoSet:

Public Member Functions
	~MeasureInfoSet ()
	destructor

bool	is2dMeasureSet () const

bool	is3dMeasureSet () const

const GeometricCalibrationConstPtr &	getGlobalGeometricCalibration () const
	retrieve global geometric calibration attached to object More...

const MeasureInfoColl &	getMeasureInfoColl () const
	retrieve collection of measure information objects

void	extractNeededInputs (ShapeCollIdSet &shapeCollIdSet, ImageIdSet &imageIdSet) const
	extract needed inputs data for measurements

bool	requiresRowIntersections (const eMsrInputShapeCollId &shapeCollId) const

bool	requiresBoundaryApproximation (const eMsrInputShapeCollId &shapeCollId) const

const AliasMap &	getAliasMap () const
	retrieve measure alias map

bool	existsMeasureInfo (const std::string &measureName, const eMsrNameType &msrNameType=eMsrNameType::eMNT_User) const
	check whether a given named measure information exists into collection

bool	existsMeasureInfo (const std::string &measureDefaultName, const MeasureConfigConstPtr &pMeasureConfig, const DataItemConstPtr &pMeasureParams) const
	check whether a given measure information exists into collection

void	getMeasureInfoColl (const std::string &defaultMeasureName, MeasureInfoColl &measureInfoColl) const
	retrieve collection of measure information object associated to a given default name

void	clear ()
	clear of object data


BoolResult	createMeasureInfo (const std::string &measureName, const std::string &measureDefaultName, const DataItemConstPtr &pMeasureParams)
	create a new measure information More...

BoolResult	createMeasureInfo (const std::string &measureName, const std::string &measureDefaultName, const MeasureConfigConstPtr &pMeasureConfig=MeasureConfigConstPtr(), const DataItemConstPtr &pMeasureParams=DataItemConstPtr())
	create a new measure information More...


BoolResult	createMeasureInfo (const std::string &measureDefaultName, const DataItemConstPtr &pMeasureParams)
	create a new measure information with its default name More...

BoolResult	createMeasureInfo (const std::string &measureDefaultName, const MeasureConfigConstPtr &pMeasureConfig=MeasureConfigConstPtr(), const DataItemConstPtr &pMeasureParams=DataItemConstPtr())
	create a new measure information with its default name More...


MeasureInfoConstPtr	getMeasureInfo (const std::string &measureName) const
	retrieve a named measure information from collection More...

const MeasureInfoPtr &	getMeasureInfo (const std::string &measureName)
	retrieve a named measure information from collection More...

Public Member Functions inherited from ipsdk::BaseSerializationObject
	BaseSerializationObject ()
	Default constructor.

virtual	~BaseSerializationObject ()=0
	destructor

Public Member Functions inherited from ipsdk::BaseDynamicObject
virtual const std::string &	getClassName () const
	method allowing to retrieve object class name

virtual BaseDynamicObject *	createNew () const =0
	method allowing to create new instance of current object type

virtual DynamicObjectPtr	createShared () const =0
	method allowing to create new shared instance of current object type

virtual bool	hasCopySupport () const =0
	check whether objet has copy support

virtual BaseDynamicObject *	duplicate () const =0
	method allowing to duplicate current object More...

virtual DynamicObjectPtr	duplicateShared () const =0
	method allowing shared duplication of current object More...

	BaseDynamicObject ()

virtual	~BaseDynamicObject ()=0

Static Public Member Functions
static MeasureInfoSetPtr	create2dInstance (const GeometricCalibrationConstPtr &pGlobalGeometricCalibration=GeometricCalibrationConstPtr())
	method allowing to create an instance of 2d measure information set

static MeasureInfoSetPtr	create3dInstance (const GeometricCalibrationConstPtr &pGlobalGeometricCalibration=GeometricCalibrationConstPtr())
	method allowing to create an instance of 3d measure information set

static MeasureInfoSetPtr	createFromExisting (const MeasureInfoSet &inputMeasureInfoSet)
	method allowing to create a new measure information set from an existing one More...

Static Public Member Functions inherited from ipsdk::BaseSerializationObject
static ipUInt32	getVersion ()
	method allowing to retrieve class version information for serialization

Static Public Member Functions inherited from ipsdk::BaseDynamicObject
static const std::string &	getTypeName ()
	method allowing to retrieve name associated to class

Protected Member Functions
	MeasureInfoSet (const bool b2dMeasureSet=true, const GeometricCalibrationConstPtr &pGlobalGeometricCalibration=GeometricCalibrationConstPtr())
	constructor

Protected Member Functions inherited from ipsdk::BaseSerializationObject
virtual BoolResult	write (BaseOArchive &ar) const
	method allowing to ensure serialization write part for object

virtual BoolResult	read (BaseIArchive &ar)
	method allowing to ensure serialization read part for object

Protected Member Functions inherited from ipsdk::BaseDynamicObject
virtual void	initCtorCopy (const BaseDynamicObject &object)

virtual void	copy (const BaseDynamicObject &object)
	method allowing to copy data from another object

Protected Attributes
bool	_b2dMeasureSet
	flag indicating whether measure set is 2d or 3d

MeasureInfoColl	_measureInfoColl
	collection of measure information associated to object

AliasMap	_aliasMap
	collection of alias for measure names

GeometricCalibrationConstPtr	_pGlobalGeometricCalibration
	global calibration associated object

Friends
MeasureInfoSetPtr	boost::make_shared ()

template<class T , class... Args>
boost::detail::sp_if_not_array< T >::type	boost::make_shared (Args &&...)

Detailed Description

Object allowing to agregate a collection of measure informations.

Author: E. Noirfalise

Date: 2015/06/23

Copyright: 2015 Reactiv'IP, all right reserved.

Note: each measure name must be unique

Member Function Documentation

◆ createFromExisting()

static MeasureInfoSetPtr ipsdk::shape::analysis::MeasureInfoSet::createFromExisting ( const MeasureInfoSet & inputMeasureInfoSet )

static

method allowing to create a new measure information set from an existing one

Warning: underlying measure information are not duplicated

◆ is2dMeasureSet()

bool ipsdk::shape::analysis::MeasureInfoSet::is2dMeasureSet ( ) const

inline

check whether all measure information associated to measure information set can be used in 2d case

◆ is3dMeasureSet()

bool ipsdk::shape::analysis::MeasureInfoSet::is3dMeasureSet ( ) const

inline

check whether all measure information associated to measure information set can be used in 3d case

◆ getGlobalGeometricCalibration()

const GeometricCalibrationConstPtr& ipsdk::shape::analysis::MeasureInfoSet::getGlobalGeometricCalibration ( ) const

retrieve global geometric calibration attached to object

Returns: a null shared pointer if global geometric calibration has not been set

◆ requiresRowIntersections()

bool ipsdk::shape::analysis::MeasureInfoSet::requiresRowIntersections ( const eMsrInputShapeCollId & shapeCollId ) const

check whether a measure requires shape row intersection for a given shape collection

◆ requiresBoundaryApproximation()

bool ipsdk::shape::analysis::MeasureInfoSet::requiresBoundaryApproximation ( const eMsrInputShapeCollId & shapeCollId ) const

check whether a measure requires shape boundary approximation for a given shape collection

◆ createMeasureInfo() [1/4]

BoolResult ipsdk::shape::analysis::MeasureInfoSet::createMeasureInfo	(	const std::string &	measureName,
		const std::string &	measureDefaultName,
		const DataItemConstPtr &	pMeasureParams
	)

create a new measure information

Note: create an alias if an equivalent measure already exists

Exceptions

ipsdk::shape::analysis::IPSDKBaseShapeAnalysisException if existsMeasureInfo(measureName) == true

Returns: false if measure creation failed

◆ createMeasureInfo() [2/4]

BoolResult ipsdk::shape::analysis::MeasureInfoSet::createMeasureInfo	(	const std::string &	measureName,
		const std::string &	measureDefaultName,
		const MeasureConfigConstPtr &	pMeasureConfig = `MeasureConfigConstPtr()`,
		const DataItemConstPtr &	pMeasureParams = `DataItemConstPtr()`
	)

create a new measure information

Note: create an alias if an equivalent measure already exists

Exceptions

ipsdk::shape::analysis::IPSDKBaseShapeAnalysisException if existsMeasureInfo(measureName) == true

Returns: false if measure creation failed

◆ createMeasureInfo() [3/4]

BoolResult ipsdk::shape::analysis::MeasureInfoSet::createMeasureInfo	(	const std::string &	measureDefaultName,
		const DataItemConstPtr &	pMeasureParams
	)

create a new measure information with its default name

Note: create an alias if an equivalent measure already exists

Exceptions

ipsdk::shape::analysis::IPSDKBaseShapeAnalysisException if existsMeasureInfo(measureDefaultName) == true

Returns: false if measure creation failed

◆ createMeasureInfo() [4/4]

BoolResult ipsdk::shape::analysis::MeasureInfoSet::createMeasureInfo	(	const std::string &	measureDefaultName,
		const MeasureConfigConstPtr &	pMeasureConfig = `MeasureConfigConstPtr()`,
		const DataItemConstPtr &	pMeasureParams = `DataItemConstPtr()`
	)

create a new measure information with its default name

Note: create an alias if an equivalent measure already exists

Exceptions

ipsdk::shape::analysis::IPSDKBaseShapeAnalysisException if existsMeasureInfo(measureDefaultName) == true

Returns: false if measure creation failed

◆ getMeasureInfo() [1/2]

MeasureInfoConstPtr ipsdk::shape::analysis::MeasureInfoSet::getMeasureInfo ( const std::string & measureName ) const

retrieve a named measure information from collection

Exceptions

ipsdk::shape::analysis::IPSDKBaseShapeAnalysisException if exists(measureName) == false

◆ getMeasureInfo() [2/2]

const MeasureInfoPtr& ipsdk::shape::analysis::MeasureInfoSet::getMeasureInfo ( const std::string & measureName )

retrieve a named measure information from collection

Exceptions

ipsdk::shape::analysis::IPSDKBaseShapeAnalysisException if exists(measureName) == false

The documentation for this class was generated from the following file:

/media/reactivipdev/Nightly/IPSDK_Patch/IPSDK_4_1/IPSDK_Nightly/include/public/IPSDKBaseShapeAnalysis/Measure/Info/MeasureInfoSet.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Function Documentation

◆ createFromExisting()

◆ is2dMeasureSet()

◆ is3dMeasureSet()

◆ getGlobalGeometricCalibration()

◆ requiresRowIntersections()

◆ requiresBoundaryApproximation()

◆ createMeasureInfo() [1/4]

◆ createMeasureInfo() [2/4]

◆ createMeasureInfo() [3/4]

◆ createMeasureInfo() [4/4]

◆ getMeasureInfo() [1/2]

◆ getMeasureInfo() [2/2]