IPSDK  4_1_0_2
IPSDK : Image Processing Software Development Kit
Public Member Functions | Protected Attributes | List of all members
ipsdk::core::LocalConfiguration Class Reference

Class allowing to describe local computer processing configuration. More...

#include <LocalConfiguration.h>

Inheritance diagram for ipsdk::core::LocalConfiguration:
ipsdk::BaseSerializationObject ipsdk::BaseDynamicObject

Public Member Functions

bool isInit () const
 retrieve object initialization flag
 
void init (const eLocalProcessorType &localProcessorType, const LocalProcessingPolicy &localProcessingPolicy, const DistributedProcessingPolicy &distributedProcessingPolicy, const boost::filesystem::path &logMainDirPath, const std::string &logMainFileName, const boost::filesystem::path &userConfigurationDirPath, const boost::filesystem::path &commonConfigurationDirPath, const boost::filesystem::path &temporaryDirPath, const boost::filesystem::path &productLogoFilePath, const boost::filesystem::path &companyLogoFilePath)
 object initialization
 
const eLocalProcessorTypegetLocalProcessorType () const
 retrieve local computer processor type More...
 
const LocalProcessingPolicygetLocalProcessingPolicyConst () const
 retrieve local processing policy associated to object More...
 
LocalProcessingPolicygetLocalProcessingPolicy ()
 retrieve local processing policy associated to object More...
 
const DistributedProcessingPolicygetDistributedProcessingPolicy () const
 retrieve distributed processing policy associated to object More...
 
const boost::filesystem::path & getLogMainDirPath () const
 retrieve library log main directory More...
 
const std::string & getLogMainFileName () const
 retrieve library main log file name (name with extension) More...
 
const boost::filesystem::path & getUserConfigurationDirPath () const
 retrieve library user configuration directory More...
 
const boost::filesystem::path & getCommonConfigurationDirPath () const
 retrieve library common (all users) configuration directory More...
 
const boost::filesystem::path & getTemporaryDirPath () const
 retrieve library temporary directory More...
 
const boost::filesystem::path & getProductLogoFilePath () const
 retrieve product logo file path More...
 
const boost::filesystem::path & getCompanyLogoFilePath () const
 retrieve company logo file path More...
 
void clear ()
 clear of object data
 
Constructors and destructors
 LocalConfiguration ()
 
 ~LocalConfiguration ()
 
- 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 BaseDynamicObjectcreateNew () 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 BaseDynamicObjectduplicate () 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

eLocalProcessorType _localProcessorType
 local computer processor type
 
LocalProcessingPolicy _localProcessingPolicy
 local processing policy associated to object
 
DistributedProcessingPolicy _distributedProcessingPolicy
 distributed processing policy associated to object
 
boost::filesystem::path _logMainDirPath
 library log main directory
 
std::string _logMainFileName
 library main log file name (name with extension)
 
boost::filesystem::path _userConfigurationDirPath
 library user configuration directory
 
boost::filesystem::path _commonConfigurationDirPath
 library common (all users) configuration directory
 
boost::filesystem::path _temporaryDirPath
 library temporary directory
 
boost::filesystem::path _productLogoFilePath
 product logo file path
 
boost::filesystem::path _companyLogoFilePath
 company logo file path
 
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 allowing to describe local computer processing configuration.

Author
E. Noirfalise
Date
2013/11/29

Member Function Documentation

◆ getLocalProcessorType()

const eLocalProcessorType& ipsdk::core::LocalConfiguration::getLocalProcessorType ( ) const

retrieve local computer processor type

Exceptions
ipsdk::core::IPSDKCoreExceptionif isInit() == false

◆ getLocalProcessingPolicyConst()

const LocalProcessingPolicy& ipsdk::core::LocalConfiguration::getLocalProcessingPolicyConst ( ) const

retrieve local processing policy associated to object

Exceptions
ipsdk::core::IPSDKCoreExceptionif isInit() == false

◆ getLocalProcessingPolicy()

LocalProcessingPolicy& ipsdk::core::LocalConfiguration::getLocalProcessingPolicy ( )

retrieve local processing policy associated to object

Exceptions
ipsdk::core::IPSDKCoreExceptionif isInit() == false

◆ getDistributedProcessingPolicy()

const DistributedProcessingPolicy& ipsdk::core::LocalConfiguration::getDistributedProcessingPolicy ( ) const

retrieve distributed processing policy associated to object

Exceptions
ipsdk::core::IPSDKCoreExceptionif isInit() == false

◆ getLogMainDirPath()

const boost::filesystem::path& ipsdk::core::LocalConfiguration::getLogMainDirPath ( ) const

retrieve library log main directory

Exceptions
ipsdk::core::IPSDKCoreExceptionif isInit() == false

◆ getLogMainFileName()

const std::string& ipsdk::core::LocalConfiguration::getLogMainFileName ( ) const

retrieve library main log file name (name with extension)

Exceptions
ipsdk::core::IPSDKCoreExceptionif isInit() == false

◆ getUserConfigurationDirPath()

const boost::filesystem::path& ipsdk::core::LocalConfiguration::getUserConfigurationDirPath ( ) const

retrieve library user configuration directory

Exceptions
ipsdk::core::IPSDKCoreExceptionif isInit() == false

◆ getCommonConfigurationDirPath()

const boost::filesystem::path& ipsdk::core::LocalConfiguration::getCommonConfigurationDirPath ( ) const

retrieve library common (all users) configuration directory

Exceptions
ipsdk::core::IPSDKCoreExceptionif isInit() == false

◆ getTemporaryDirPath()

const boost::filesystem::path& ipsdk::core::LocalConfiguration::getTemporaryDirPath ( ) const

retrieve library temporary directory

Exceptions
ipsdk::core::IPSDKCoreExceptionif isInit() == false

◆ getProductLogoFilePath()

const boost::filesystem::path& ipsdk::core::LocalConfiguration::getProductLogoFilePath ( ) const

retrieve product logo file path

Exceptions
ipsdk::core::IPSDKCoreExceptionif isInit() == false

◆ getCompanyLogoFilePath()

const boost::filesystem::path& ipsdk::core::LocalConfiguration::getCompanyLogoFilePath ( ) const

retrieve company logo file path

Exceptions
ipsdk::core::IPSDKCoreExceptionif isInit() == false

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