Base class for shape analysis measurement informations. More...

#include <BaseMeasureInfo.h>

Inheritance diagram for ipsdk::shape::analysis::BaseMeasureInfo:

Public Member Functions
virtual	~BaseMeasureInfo ()=0
	destructor

virtual const std::string &	getDefaultName () const =0
	retrieve default measure name

bool	isInit () const
	check for object initialization

const std::string &	getMeasureName () const
	retrieve name associated to measure More...

bool	is2dMode () const
	check whether measure is used in 2d mode More...

MeasurePtr	createMeasure () const
	creation of a measure object associated to measure informations More...

Measure processing policy informations
virtual eMsrProcessingPolicy	getMsrProcessingPolicy () const =0
	retrieve measure processing policy

eMsrVolumePolicy	getMsrVolumePolicy () const
	retrieve measure volume policy

bool	is2dMsr () const
	check whether measure can be used in 2d case

bool	is3dMsr () const
	check whether measure can be used in 3d case

virtual bool	requiresInputImage () const
	check whether measure requires input image

virtual eMsrShapeRequirements	getMsrShapeRequirements () const =0
	retrieve shape data requirements associated to measure

bool	requiresRowIntersections () const
	check whether measure requires shape row intersection

bool	requiresBoundaryApproximation () const
	check whether measure requires shape boundary approximation

Geometric calibration
const GeometricCalibrationConstPtr &	getGeometricCalibration () const
	retrieve geometric calibration associated to measure More...

virtual eMsrUnitFormat	getMsrUnitFormat () const =0
	retrieve unit format associated to measure

std::string	getMsrUnitStr () const
	retrieve formatted unit string associated to measure More...

Measure primary configuration
MeasureConfigConstPtr	getMsrConfig () const
	retrieve measure primary configuration More...

bool	hasDefaultConfig () const
	method allowing to check whether measure is associated to its default primary configuration More...

Measure parameters
virtual DataItemPtr	createDefaultParams () const

bool	hasDefaultParams () const
	method allowing to check whether measure is associated to its specific default parameters More...

bool	hasParams (const MeasureConfigConstPtr &pConfig, const DataItemConstPtr &pParams) const
	method allowing to check whether measure parameters match More...

DataItemConstPtr	getMsrParams () const
	retrieve measure specific parameters More...

Dependency measure collection
Measures on which current measure depend
bool	dependsOnNamedMsr (const std::string &dependencyName) const
	check whether a given named dependency measure information already exists More...

bool	dependsOn (const std::string &dependencyDefaultName) const
	check whether a given dependency measure information already exists given its default name and a default configuration More...

bool	dependsOn (const std::string &dependencyDefaultName, const MeasureConfigConstPtr &pDependencyConfig, const DataItemConstPtr &pDependencyParams) const
	check whether a given dependency measure information already exists given its default name and its configuration More...

MeasureConfigConstPtr	getDependencyConfig (const std::string &dependencyName) const
	retrieve dependency measure primary configuration More...

DataItemConstPtr	getDependencyParams (const std::string &dependencyName) const
	retrieve dependency measure specific parameters More...

const DependencyMap &	getDependencies () const
	retrieve measure dependencies 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

Public Member Functions inherited from ipsdk::BaseToolTip
virtual const std::string &	getObjectName () const =0
	retrieve object name

virtual const std::string &	getToolTip () const =0
	retrieve object tool tip

	BaseToolTip ()

virtual	~BaseToolTip ()=0

Protected Member Functions
	BaseMeasureInfo ()
	constructor

virtual MeasurePtr	createMeasureDerived () const =0

virtual BoolResult	validateMsrParams (const bool b2dMsrMode, const DataItemConstPtr &pMeasureParams) const
	method allowing to validate measure parameters in derived class

virtual void	initDerived ()=0
	// initialization of object in derived class

virtual std::string	computeCustomMsrUnitStr (const std::string &baseUnitStr) const

virtual void	createDependencies (const bool b2dMsrMode)=0
	method allowing to retrieve standard dependencies informations

virtual void	createCustomDependencies (const bool b2dMsrMode)
	method allowing to retrieve custom dependencies informations

void	addDependency (const std::string &dependencyDefaultName)
	method allowing to add a dependency to measure with default measure configuration More...

void	addDependency (const std::string &dependencyName, const std::string &dependencyDefaultName, const MeasureConfigConstPtr &pDependencyConfig, const DataItemConstPtr &pDependencyParams)
	method allowing to add a dependency to measure with additional measure informations More...

void	addNamedMsrDependency (const std::string &dependencyName)
	method allowing to add a dependency to a named measure without additional measure informations More...

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

Friends
class	MeasureInfoFactory

Additional Inherited Members
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

Detailed Description

Base class for shape analysis measurement informations.

Author: E. Noirfalise

Date: 2015/06/23

Copyright: 2015 Reactiv'IP, all right reserved.

Member Function Documentation

◆ getMeasureName()

const std::string& ipsdk::shape::analysis::BaseMeasureInfo::getMeasureName ( ) const

retrieve name associated to measure

Note: measure name can be different of default one in case of multiple instances of a given measure for example

Exceptions

ipsdk::shape::analysis::IPSDKBaseShapeAnalysisException if isInit() == false

◆ is2dMode()

bool ipsdk::shape::analysis::BaseMeasureInfo::is2dMode ( ) const

check whether measure is used in 2d mode

Exceptions

ipsdk::shape::analysis::IPSDKBaseShapeAnalysisException if isInit() == false

◆ getGeometricCalibration()

const GeometricCalibrationConstPtr& ipsdk::shape::analysis::BaseMeasureInfo::getGeometricCalibration ( ) const

retrieve geometric calibration associated to measure

Returns: a null pointer if no calibration is associated to measure

Exceptions

ipsdk::shape::analysis::IPSDKBaseShapeAnalysisException if isInit() == false

◆ getMsrUnitStr()

std::string ipsdk::shape::analysis::BaseMeasureInfo::getMsrUnitStr ( ) const

retrieve formatted unit string associated to measure

Exceptions

ipsdk::shape::analysis::IPSDKBaseShapeAnalysisException if isInit() == false

◆ getMsrConfig()

MeasureConfigConstPtr ipsdk::shape::analysis::BaseMeasureInfo::getMsrConfig ( ) const

retrieve measure primary configuration

Exceptions

ipsdk::shape::analysis::IPSDKBaseShapeAnalysisException if isInit() == false

◆ hasDefaultConfig()

bool ipsdk::shape::analysis::BaseMeasureInfo::hasDefaultConfig ( ) const

method allowing to check whether measure is associated to its default primary configuration

Exceptions

ipsdk::shape::analysis::IPSDKBaseShapeAnalysisException if isInit() == false

◆ createDefaultParams()

virtual DataItemPtr ipsdk::shape::analysis::BaseMeasureInfo::createDefaultParams ( ) const

inlinevirtual

method allowing to create default specific parameters for measure in derived class

◆ hasDefaultParams()

bool ipsdk::shape::analysis::BaseMeasureInfo::hasDefaultParams ( ) const

method allowing to check whether measure is associated to its specific default parameters

Exceptions

ipsdk::shape::analysis::IPSDKBaseShapeAnalysisException if isInit() == false

◆ hasParams()

bool ipsdk::shape::analysis::BaseMeasureInfo::hasParams	(	const MeasureConfigConstPtr &	pConfig,
		const DataItemConstPtr &	pParams
	)		const

method allowing to check whether measure parameters match

Exceptions

ipsdk::shape::analysis::IPSDKBaseShapeAnalysisException if isInit() == false

◆ getMsrParams()

DataItemConstPtr ipsdk::shape::analysis::BaseMeasureInfo::getMsrParams ( ) const

retrieve measure specific parameters

Exceptions

ipsdk::shape::analysis::IPSDKBaseShapeAnalysisException if isInit() == false

Returns: a null shared pointer if measure has no specific parameters

◆ dependsOnNamedMsr()

bool ipsdk::shape::analysis::BaseMeasureInfo::dependsOnNamedMsr ( const std::string & dependencyName ) const

check whether a given named dependency measure information already exists

Exceptions

ipsdk::shape::analysis::IPSDKBaseShapeAnalysisException if isInit() == false

◆ dependsOn() [1/2]

bool ipsdk::shape::analysis::BaseMeasureInfo::dependsOn ( const std::string & dependencyDefaultName ) const

check whether a given dependency measure information already exists given its default name and a default configuration

Exceptions

ipsdk::shape::analysis::IPSDKBaseShapeAnalysisException if isInit() == false

◆ dependsOn() [2/2]

bool ipsdk::shape::analysis::BaseMeasureInfo::dependsOn	(	const std::string &	dependencyDefaultName,
		const MeasureConfigConstPtr &	pDependencyConfig,
		const DataItemConstPtr &	pDependencyParams
	)		const

check whether a given dependency measure information already exists given its default name and its configuration

Exceptions

ipsdk::shape::analysis::IPSDKBaseShapeAnalysisException if isInit() == false

◆ getDependencyConfig()

MeasureConfigConstPtr ipsdk::shape::analysis::BaseMeasureInfo::getDependencyConfig ( const std::string & dependencyName ) const

retrieve dependency measure primary configuration

Exceptions

ipsdk::shape::analysis::IPSDKBaseShapeAnalysisException if dependsOnNamedMsr(getDepencyUsedName(getMeasureName(), dependencyName)) == false

◆ getDependencyParams()

DataItemConstPtr ipsdk::shape::analysis::BaseMeasureInfo::getDependencyParams ( const std::string & dependencyName ) const

retrieve dependency measure specific parameters

Exceptions

ipsdk::shape::analysis::IPSDKBaseShapeAnalysisException if dependsOnNamedMsr(getDepencyUsedName(getMeasureName(), dependencyName)) == false

◆ getDependencies()

const DependencyMap& ipsdk::shape::analysis::BaseMeasureInfo::getDependencies ( ) const

retrieve measure dependencies

Exceptions

ipsdk::shape::analysis::IPSDKBaseShapeAnalysisException if isInit() == false

◆ createMeasure()

MeasurePtr ipsdk::shape::analysis::BaseMeasureInfo::createMeasure ( ) const

creation of a measure object associated to measure informations

Exceptions

ipsdk::shape::analysis::IPSDKBaseShapeAnalysisException if isInit() == false

◆ createMeasureDerived()

virtual MeasurePtr ipsdk::shape::analysis::BaseMeasureInfo::createMeasureDerived ( ) const

protectedpure virtual

create measure object associated to measure informations into derived class

◆ computeCustomMsrUnitStr()

virtual std::string ipsdk::shape::analysis::BaseMeasureInfo::computeCustomMsrUnitStr ( const std::string & baseUnitStr ) const

inlineprotectedvirtual

function allowing to define measure unit string in case of a custom unit format

◆ addDependency() [1/2]

void ipsdk::shape::analysis::BaseMeasureInfo::addDependency ( const std::string & dependencyDefaultName )

protected

method allowing to add a dependency to measure with default measure configuration

Exceptions

ipsdk::shape::analysis::IPSDKBaseShapeAnalysisException if dependsOn(dependencyDefaultName) == true

◆ addDependency() [2/2]

void ipsdk::shape::analysis::BaseMeasureInfo::addDependency	(	const std::string &	dependencyName,
		const std::string &	dependencyDefaultName,
		const MeasureConfigConstPtr &	pDependencyConfig,
		const DataItemConstPtr &	pDependencyParams
	)

protected

method allowing to add a dependency to measure with additional measure informations

Exceptions

ipsdk::shape::analysis::IPSDKBaseShapeAnalysisException	if dependsOnNamedMsr(dependencyName) == true
ipsdk::shape::analysis::IPSDKBaseShapeAnalysisException	if dependsOn(dependencyDefaultName, pDependencyConfig, pDependencyParams) == true

◆ addNamedMsrDependency()

void ipsdk::shape::analysis::BaseMeasureInfo::addNamedMsrDependency ( const std::string & dependencyName )

protected

method allowing to add a dependency to a named measure without additional measure informations

Exceptions

ipsdk::shape::analysis::IPSDKBaseShapeAnalysisException if dependsOnNamedMsr(dependencyName) == true

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/BaseMeasureInfo.h

Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getMeasureName()

◆ is2dMode()

◆ getGeometricCalibration()

◆ getMsrUnitStr()

◆ getMsrConfig()

◆ hasDefaultConfig()

◆ createDefaultParams()

◆ hasDefaultParams()

◆ hasParams()

◆ getMsrParams()

◆ dependsOnNamedMsr()

◆ dependsOn() [1/2]

◆ dependsOn() [2/2]

◆ getDependencyConfig()

◆ getDependencyParams()

◆ getDependencies()

◆ createMeasure()

◆ createMeasureDerived()

◆ computeCustomMsrUnitStr()

◆ addDependency() [1/2]

◆ addDependency() [2/2]

◆ addNamedMsrDependency()