ipsdk::processor::ProcessorDispatchPolicy Class Reference

Class encapsuling dispatch policy for processor dispatcher classes. More...

#include <ProcessorDispatchPolicy.h>

Inheritance diagram for ipsdk::processor::ProcessorDispatchPolicy:

Public Member Functions
bool	isInit () const
	retrieve object initialisation flag
void	initDefault ()
	initialize object with local and remote data split default capabilities
void	initLocal ()
	initialize object with local only data split default capabilities
void	initLocalAndRemote (const ipUInt32 nbMaxThread)
	initialize object with local and remote data split default capabilities and a maximum number of processing threads More...
void	initMonoThread ()
void	initLocal (const ipUInt32 nbMaxThread)
	initialize object with local only data split default capabilities and a maximum number of processing threads More...
void	initRemote (const ipUInt32 nbMaxThread)
	initialize object with remote only data split default capabilities and a maximum number of processing threads More...
void	init (const eDispatchLocationType &dispatchLocationType, const ipUInt32 nbMaxThread)
	initialize object with given data split location capabilities and a maximum number of processing threads More...
ipUInt32	getNbMaxThread () const
	retrieve maximum number of thread used for dispatch More...
const eDispatchLocationType &	getDispatchLocationType () const
	retrieve dispatch location type associated to object More...
bool	isLocalProcessingAllowed () const
	check whether configuration allow local processing More...
bool	isRemoteProcessingAllowed () const
	check whether configuration allow remote processing More...
void	retrictPolicy (const ProcessorDispatchPolicy &policy)
	restrict policy to another policy More...
void	clear ()
	clear object data
Constructors and destructors
	ProcessorDispatchPolicy ()
	~ProcessorDispatchPolicy ()
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 Attributes
ipUInt32	_nbMaxThread
	maximum number of thread used for dispatch
eDispatchLocationType	_dispatchLocationType
	dispatch location policy type
bool	_bInit
	object initialization flag

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 encapsuling dispatch policy for processor dispatcher classes.

Author

E. Noirfalise

Date

2013/10/18

Copyright

2013 Reactiv'IP, all right reserved.

Member Function Documentation

initLocalAndRemote()

void ipsdk::processor::ProcessorDispatchPolicy::initLocalAndRemote

(

const ipUInt32

nbMaxThread

)

initialize object with local and remote data split default capabilities and a maximum number of processing threads

Exceptions

ipsdk::processor::IPSDKBaseProcessingException

if nbMaxThread == 0

initMonoThread()

void ipsdk::processor::ProcessorDispatchPolicy::initMonoThread

(

)

initialize object with local only data split default capabilities and a maximum number of processing threads set to 1

initLocal()

void ipsdk::processor::ProcessorDispatchPolicy::initLocal

(

const ipUInt32

nbMaxThread

)

initialize object with local only data split default capabilities and a maximum number of processing threads

Exceptions

ipsdk::processor::IPSDKBaseProcessingException

if nbMaxThread == 0

initRemote()

void ipsdk::processor::ProcessorDispatchPolicy::initRemote

(

const ipUInt32

nbMaxThread

)

initialize object with remote only data split default capabilities and a maximum number of processing threads

Exceptions

ipsdk::processor::IPSDKBaseProcessingException

if nbMaxThread == 0

init()

void ipsdk::processor::ProcessorDispatchPolicy::init	(	const eDispatchLocationType &	dispatchLocationType,
		const ipUInt32	nbMaxThread
	)

initialize object with given data split location capabilities and a maximum number of processing threads

Exceptions

ipsdk::processor::IPSDKBaseProcessingException

if nbMaxThread == 0

getNbMaxThread()

ipUInt32 ipsdk::processor::ProcessorDispatchPolicy::getNbMaxThread

(

)

const

retrieve maximum number of thread used for dispatch

Exceptions

ipsdk::processor::IPSDKBaseProcessingException

if isInit() == false

getDispatchLocationType()

const eDispatchLocationType& ipsdk::processor::ProcessorDispatchPolicy::getDispatchLocationType

(

)

const

retrieve dispatch location type associated to object

Exceptions

ipsdk::processor::IPSDKBaseProcessingException

if isInit() == false

isLocalProcessingAllowed()

bool ipsdk::processor::ProcessorDispatchPolicy::isLocalProcessingAllowed

(

)

const

check whether configuration allow local processing

Exceptions

ipsdk::processor::IPSDKBaseProcessingException

if isInit() == false

isRemoteProcessingAllowed()

bool ipsdk::processor::ProcessorDispatchPolicy::isRemoteProcessingAllowed

(

)

const

check whether configuration allow remote processing

Exceptions

ipsdk::processor::IPSDKBaseProcessingException

if isInit() == false

retrictPolicy()

void ipsdk::processor::ProcessorDispatchPolicy::retrictPolicy

(

const ProcessorDispatchPolicy &

policy

)

restrict policy to another policy

Note

if dispatch location type are not compatible, previous dispatch location type is left unchanged

Exceptions

ipsdk::processor::IPSDKBaseProcessingException	if isInit() == false
ipsdk::processor::IPSDKBaseProcessingException	if policy.isInit() == false

---

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

• /media/reactivipdev/Nightly/IPSDK_Patch/IPSDK_4_1/IPSDK_Nightly/include/public/IPSDKBaseProcessing/Processor/Policy/ProcessorDispatchPolicy.h