Class allowing to describe processing policy for local machine. More...

#include <LocalProcessingPolicy.h>

Inheritance diagram for ipsdk::core::LocalProcessingPolicy:

Public Member Functions
bool	isInit () const
	retrieve object initialization flag

void	init (const ipUInt32 nbMaxThreads, const ipUInt64 minMemSzPerThread, const ipUInt64 maxMemSzPerThread, const boost::filesystem::path &diskImagePath="")
	object initialization

void	initDefault ()
	object default initialization

ipUInt32	getNbMaxThreads () const
	retrieve maximum number of usable thread for processings on local computer (default : number of logical cores) More...

ipUInt64	getMinMemSzPerThread () const
	retrieve minimum physical memory (RAM) used by each thread More...

ipUInt64	getMaxMemSzPerThread () const
	retrieve maximum physical memory (RAM) used by each thread on local computer (default : getDefaultMaxMemSzPerThread()) More...

const boost::filesystem::path &	getAllocatedDiskImagePath (void) const
	return the path to the directory where the automatically disk images are created More...

void	setNbMaxThreads (const ipUInt32 nbmaxThreads)
	modify the maximum number of usable thread for processings on local computer More...

void	setMinMemSzPerThread (const ipUInt64 minMemSzPerThread)
	modify the minimum physical memory (RAM) used by each thread on local computer More...

void	setMaxMemSzPerThread (const ipUInt64 maxMemSzPerThread)
	modify the maximum physical memory (RAM) used by each thread on local computer More...

void	setAllocatedDiskImagePath (const boost::filesystem::path &dirPath)
	modify the path to the directory where the automatically disk images are created More...

BoolResult	save (const boost::filesystem::path &dirPath) const
	save the local processing policy in the input directory

BoolResult	save () const
	save the local processing policy in the default directory

void	clear ()
	clear of object data

Constructors and destructors
	LocalProcessingPolicy ()

	~LocalProcessingPolicy ()

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 ipUInt64	getDefaultNbMaxThreads ()

static ipUInt64	getDefaultMinMemSzPerThread ()

static ipUInt64	getDefaultMaxMemSzPerThread ()

static boost::filesystem::path	getDefaultAllocatedDiskImagePath ()

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
void	checkValues ()
	checks that provided values are in allowed ranges, and adjust it if not

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

ipUInt64	_maxMemSzPerThread

ipUInt64	_minMemSzPerThread

boost::filesystem::path	_diskImagePath
	Directory where automatically allocated disk images are created.

bool	_bInit
	object initialization flag

Detailed Description

Class allowing to describe processing policy for local machine.

Author: E. Noirfalise

Date: 2013/12/2

Copyright: 2013 Reactiv'IP, all right reserved.

Member Function Documentation

◆ getDefaultNbMaxThreads()

static ipUInt64 ipsdk::core::LocalProcessingPolicy::getDefaultNbMaxThreads ( )

static

method allowing to retrieve default value for maximum number of usable thread for processings on local computer (i.e. number of logical cores)

◆ getDefaultMinMemSzPerThread()

static ipUInt64 ipsdk::core::LocalProcessingPolicy::getDefaultMinMemSzPerThread ( )

static

method allowing to retrieve default value for minimum physical memory (RAM) used by each thread on local computer (default : 100 * 1024)

◆ getDefaultMaxMemSzPerThread()

static ipUInt64 ipsdk::core::LocalProcessingPolicy::getDefaultMaxMemSzPerThread ( )

static

method allowing to retrieve default value for maximum physical memory (RAM) used by each thread on local computer (default : 100 * 1024 * 1024)

◆ getDefaultAllocatedDiskImagePath()

static boost::filesystem::path ipsdk::core::LocalProcessingPolicy::getDefaultAllocatedDiskImagePath ( )

static

method allowing to retrieve default the path to the directory where the automatically disk images are created By default, the path is C:<USER> on windows and /tmp/ReactivIP/IPSDK on Linux.

◆ getNbMaxThreads()

ipUInt32 ipsdk::core::LocalProcessingPolicy::getNbMaxThreads ( ) const

retrieve maximum number of usable thread for processings on local computer (default : number of logical cores)

Exceptions