ipsdk::processor::DataTypeIdentifierColl Class Reference

Class used for data type collection function identification. More...

#include <DataTypeIdentifierColl.h>

Inheritance diagram for ipsdk::processor::DataTypeIdentifierColl:

Public Types
typedef BaseDataTypeIdentifier	DataTypeId
	data type identifier used by collection

Public Member Functions
bool	isInit () const
	retrieve object initialisation flag
void	init ()
	initialization of object with no data type identifier
void	init (const DataTypeId &dataTypeId)
	initialization of object with a single data type identifier More...
void	init (const DataTypeId &dataTypeId1, const DataTypeId &dataTypeId2)
	initialization of object with two data type identifiers More...
void	init (const DataTypeId &dataTypeId1, const DataTypeId &dataTypeId2, const DataTypeId &dataTypeId3)
	initialization of object with three data type identifiers More...
ipUInt32	getNbDataTypeId () const
	retrieve number of data type identifiers More...
const DataTypeId &	getDataTypeId (ipUInt32 dataTypeIdIdx) const
	retrieve first data type identifier More...
void	clear ()
	clear of object data
Constructors and destructors
	DataTypeIdentifierColl ()
	~DataTypeIdentifierColl ()
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 Types
typedef boost::shared_ptr< DataTypeId >	DataTypeIdPtr
	shared pointer to data type identifier
typedef std::vector< DataTypeIdPtr >	DataTypeIdColl
	collection of data type identifiers

Protected Attributes
DataTypeIdColl	_dataTypeIdColl
	Data type identifiers associated to object.
bool	_bInit
	object initialisation flag

Friends
IPSDKBASEPROCESSING_API bool	operator< (const DataTypeIdentifierColl &dataTypeIdColl1, const DataTypeIdentifierColl &dataTypeIdColl2)
	comparison operator More...

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 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

Detailed Description

Class used for data type collection function identification.

Author

E. Noirfalise

Date

2014/02/17

Copyright

2014 Reactiv'IP, all right reserved.

Member Function Documentation

init() [1/3]

void ipsdk::processor::DataTypeIdentifierColl::init

(

const DataTypeId &

dataTypeId

)

initialization of object with a single data type identifier

Exceptions

ipsdk::processor::IPSDKBaseProcessingException

if dataTypeId.isInit() == false

init() [2/3]

void ipsdk::processor::DataTypeIdentifierColl::init	(	const DataTypeId &	dataTypeId1,
		const DataTypeId &	dataTypeId2
	)

initialization of object with two data type identifiers

Exceptions

ipsdk::processor::IPSDKBaseProcessingException	if dataTypeId1.isInit() == false
ipsdk::processor::IPSDKBaseProcessingException	if dataTypeId2.isInit() == false

init() [3/3]

void ipsdk::processor::DataTypeIdentifierColl::init	(	const DataTypeId &	dataTypeId1,
		const DataTypeId &	dataTypeId2,
		const DataTypeId &	dataTypeId3
	)

initialization of object with three data type identifiers

Exceptions

ipsdk::processor::IPSDKBaseProcessingException	if dataTypeId1.isInit() == false
ipsdk::processor::IPSDKBaseProcessingException	if dataTypeId2.isInit() == false
ipsdk::processor::IPSDKBaseProcessingException	if dataTypeId3.isInit() == false

getNbDataTypeId()

ipUInt32 ipsdk::processor::DataTypeIdentifierColl::getNbDataTypeId

(

)

const

retrieve number of data type identifiers

Exceptions

ipsdk::processor::IPSDKBaseProcessingException

if isInit() == false

getDataTypeId()

const DataTypeId& ipsdk::processor::DataTypeIdentifierColl::getDataTypeId

(

ipUInt32

dataTypeIdIdx

)

const

retrieve first data type identifier

Exceptions

ipsdk::processor::IPSDKBaseProcessingException

if dataTypeIdIdx >= getNbDataTypeId()

Friends And Related Function Documentation

operator<

IPSDKBASEPROCESSING_API bool operator< ( const DataTypeIdentifierColl &  dataTypeIdColl1, const DataTypeIdentifierColl &  dataTypeIdColl2  )

friend

comparison operator

Exceptions

ipsdk::imaproc::IPSDKBaseProcessingException	if dataTypeIdColl1.getNbDataTypeId() != dataTypeIdColl2.getNbDataTypeId()
ipsdk::processor::IPSDKBaseProcessingException	if underlying data type identifier types mismatch

---

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

• /media/reactivipdev/Nightly/IPSDK_Patch/IPSDK_4_1/IPSDK_Nightly/include/public/IPSDKBaseProcessing/Algorithm/Function/DataTypeIdentifierColl.h