ipsdk::shape::analysis::BaseMeasureResult Class Reference

Base class for measure results. More...

#include <BaseMeasureResult.h>

Inheritance diagram for ipsdk::shape::analysis::BaseMeasureResult:

Public Member Functions
virtual eMsrResultType	getMsrResultType () const =0
	retrieve measure result type associated to object
bool	isInit () const
	retrieve object initialization flag
void	init (const ipUInt64 nbColorPlans, const ipUInt64 nbEntities)
	initialization of object
ipUInt64	getNbColorPlans () const
	retrieve number of color plans results associated to object More...
ipUInt64	getNbEntities () const
	retrieve number of shape entity results associated to object More...
bool	isValid (const ipUInt64 cPlanIdx) const
	check for color plan index validity More...
void	collectResults (const ipUInt64 resultStartIndex, const BaseMeasureResult &baseSubResults)
	merge of a sub result into object More...
void	collectResults (const UInt64Vector &subDataIdxColl, const BaseMeasureResult &baseSubResults)
	merge of a sub result into object More...
void	extractResults (const ipUInt64 resultStartIndex, const BaseMeasureResult &baseMainResults)
	extract of a sub result from another object More...
void	extractResults (const UInt64Vector &mainDataIdxColl, const BaseMeasureResult &baseMainResults)
	extract of a sub result from another object More...
void	clear ()
	clear of object data
Constructors and destructors
	BaseMeasureResult ()
virtual	~BaseMeasureResult ()=0
Public Member Functions inherited from ipsdk::BaseObjectWithSkeleton
const eSklSrzMode &	getSerializationMode () const
	retrieve serialization flag for object More...
void	setSerializationMode (const eSklSrzMode &sklSrzMode) const
	set serialization flag for object
	BaseObjectWithSkeleton ()
	~BaseObjectWithSkeleton ()
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

Protected Member Functions
virtual void	initDerived (const ipUInt64 nbColorPlans, const ipUInt64 nbEntities)=0
	initialization of object in derived class
virtual void	clearDerived ()=0
	clear of object data in derived class
virtual void	collectResultsDerived (const ipUInt64 resultStartIndex, const BaseMeasureResult &subResults)=0
	merge of a sub result into object in derived class
virtual void	collectResultsDerived (const UInt64Vector &subDataIdxColl, const BaseMeasureResult &subResults)=0
	merge of a sub result into object in derived class
virtual void	extractResultsDerived (const ipUInt64 resultStartIndex, const BaseMeasureResult &baseMainResults)=0
	extract of a sub result from another object
virtual void	extractResultsDerived (const UInt64Vector &mainDataIdxColl, const BaseMeasureResult &baseMainResults)=0
	extract of a sub result from another object
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

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
Protected Attributes inherited from ipsdk::BaseObjectWithSkeleton
eSklSrzMode	_sklSrzMode
	serialization flag for object More...

Detailed Description

Base class for measure results.

Author

E. Noirfalise

Date

2015/06/23

Copyright

2015 Reactiv'IP, all right reserved.

A measure result object is composed of data for each shape entity

Member Function Documentation

getNbColorPlans()

ipUInt64 ipsdk::shape::analysis::BaseMeasureResult::getNbColorPlans

(

)

const

retrieve number of color plans results associated to object

Exceptions

ipsdk::shape::analysis::IPSDKBaseShapeAnalysisException

if isInit() == false

getNbEntities()

ipUInt64 ipsdk::shape::analysis::BaseMeasureResult::getNbEntities

(

)

const

retrieve number of shape entity results associated to object

Exceptions

ipsdk::shape::analysis::IPSDKBaseShapeAnalysisException

if isInit() == false

isValid()

bool ipsdk::shape::analysis::BaseMeasureResult::isValid

(

const ipUInt64

cPlanIdx

)

const

check for color plan index validity

Exceptions

ipsdk::shape::analysis::IPSDKBaseShapeAnalysisException

if isInit() == false

collectResults() [1/2]

void ipsdk::shape::analysis::BaseMeasureResult::collectResults	(	const ipUInt64	resultStartIndex,
		const BaseMeasureResult &	baseSubResults
	)

merge of a sub result into object

Exceptions

ipsdk::shape::analysis::IPSDKBaseShapeAnalysisException	if baseSubResults.getClassName() != getClassName()
ipsdk::shape::analysis::IPSDKBaseShapeAnalysisException	if baseSubResults.getNbColorPlans() != getNbColorPlans()
ipsdk::shape::analysis::IPSDKBaseShapeAnalysisException	if resultStartIndex + baseSubResults.getNbEntities() > getNbEntities()

collectResults() [2/2]

void ipsdk::shape::analysis::BaseMeasureResult::collectResults	(	const UInt64Vector &	subDataIdxColl,
		const BaseMeasureResult &	baseSubResults
	)

merge of a sub result into object

Exceptions

ipsdk::shape::analysis::IPSDKBaseShapeAnalysisException	if baseSubResults.getClassName() != getClassName()
ipsdk::shape::analysis::IPSDKBaseShapeAnalysisException	if baseSubResults.getNbColorPlans() != getNbColorPlans()
ipsdk::shape::analysis::IPSDKBaseShapeAnalysisException	if subDataIdxColl.size() != baseSubResults.getNbEntities()

Warning

their is no check on subDataIdxColl indexes validity

extractResults() [1/2]

void ipsdk::shape::analysis::BaseMeasureResult::extractResults	(	const ipUInt64	resultStartIndex,
		const BaseMeasureResult &	baseMainResults
	)

extract of a sub result from another object

Exceptions

ipsdk::shape::analysis::IPSDKBaseShapeAnalysisException	if baseMainResults.getClassName() != getClassName()
ipsdk::shape::analysis::IPSDKBaseShapeAnalysisException	if baseMainResults.getNbColorPlans() != getNbColorPlans()
ipsdk::shape::analysis::IPSDKBaseShapeAnalysisException	if resultStartIndex + getNbEntities() > baseMainResults.getNbEntities()

extractResults() [2/2]

void ipsdk::shape::analysis::BaseMeasureResult::extractResults	(	const UInt64Vector &	mainDataIdxColl,
		const BaseMeasureResult &	baseMainResults
	)

extract of a sub result from another object

Exceptions

ipsdk::shape::analysis::IPSDKBaseShapeAnalysisException	if baseMainResults.getClassName() != getClassName()
ipsdk::shape::analysis::IPSDKBaseShapeAnalysisException	if baseMainResults.getNbColorPlans() != getNbColorPlans()
ipsdk::shape::analysis::IPSDKBaseShapeAnalysisException	if mainDataIdxColl.size() != getNbEntities()

Warning

their is no check on subDataIdxColl indexes validity

---

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/Result/BaseMeasureResult.h