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

User configuration for IPSDK library. More...

#include <LibraryUserConfiguration.h>

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

Public Member Functions

bool isInit () const
 retrieve object initialization flag
 
void init ()
 object initialization method
 
Constructors and destructors
 LibraryUserConfiguration ()
 
 ~LibraryUserConfiguration ()
 
const boost::filesystem::path & getProjectRootDirectory () const
 access to project root directory More...
 
void setProjectRootDirectory (const boost::filesystem::path &projectRootDirectory)
 access to project root directory More...
 
const boost::filesystem::path & getLogMainDirPath () const
 access to library log main directory More...
 
void setLogMainDirPath (const boost::filesystem::path &logMainDirPath)
 access to library log main directory More...
 
const std::string & getLogMainFileName () const
 access to library main log file name (name with extension) More...
 
void setLogMainFileName (const std::string &logMainFileName)
 access to library main log file name (name with extension) More...
 
bool isLogDailyRollingFileAppenderUsed () const
 access to flag indicating whether a daily rolling file appender is used for main log file More...
 
void setUseLogDailyRollingFileAppender (const bool bUseLogDailyRollingFileAppender)
 access to flag indicating whether a daily rolling file appender is used for main log file More...
 
const boost::filesystem::path & getUserConfigurationDirPath () const
 access to library user configuration directory More...
 
void setUserConfigurationDirPath (const boost::filesystem::path &userConfigurationDirPath)
 access to library user configuration directory More...
 
const boost::filesystem::path & getCommonConfigurationDirPath () const
 access to library common (all users) configuration directory More...
 
void setCommonConfigurationDirPath (const boost::filesystem::path &commonConfigurationDirPath)
 access to library common (all users) configuration directory More...
 
const boost::filesystem::path & getTemporaryDirPath () const
 access to library temporary directory More...
 
void setTemporaryDirPath (const boost::filesystem::path &temporaryDirPath)
 access to library temporary directory More...
 
const boost::filesystem::path & getLocalProcessingPolicyFilePath () const
 access to library local processing policy file path More...
 
void setLocalProcessingPolicyFilePath (const boost::filesystem::path &localProcessingPolicyFilePath)
 access to library local processing policy file path More...
 
const boost::filesystem::path & getDistributedProcessingPolicyFilePath () const
 access to library distributed processing policy file path More...
 
void setDistributedProcessingPolicyFilePath (const boost::filesystem::path &distributedProcessingPolicyFilePath)
 access to library distributed processing policy file path More...
 
const boost::filesystem::path & getNetworkDescriptionFilePath () const
 access to library network description file path More...
 
void setNetworkDescriptionFilePath (const boost::filesystem::path &networkDescriptionFilePath)
 access to library network description file path More...
 
const boost::filesystem::path & getLicenseFilePath () const
 access to library license file path More...
 
void setLicenseFilePath (const boost::filesystem::path &licenseFilePath)
 access to library license file path More...
 
const boost::filesystem::path & getProductLogoFilePath () const
 access to product logo file path More...
 
void setProductLogoFilePath (const boost::filesystem::path &productLogoFilePath)
 access to product logo file path More...
 
const boost::filesystem::path & getCompanyLogoFilePath () const
 access to company logo file path More...
 
void setCompanyLogoFilePath (const boost::filesystem::path &companyLogoFilePath)
 access to company logo file path More...
 
bool isNetworkCapabilitiesInhibited () const
 access to flag indicating whether network capabilities should be inibited if presents (default false)
 
void setNetworkCapabilitiesInhibited (const bool bNetworkCapabilitiesInhibited)
 access to flag indicating whether network capabilities should be inibited if presents (default false)
 
- 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

boost::filesystem::path _projectRootDirectory
 project root directory
 
boost::filesystem::path _logMainDirPath
 library log main directory
 
std::string _logMainFileName
 library main log file name (name with extension)
 
bool _bUseLogDailyRollingFileAppender
 
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 _localProcessingPolicyFilePath
 library local processing policy file path More...
 
boost::filesystem::path _distributedProcessingPolicyFilePath
 library distributed processing policy file path More...
 
boost::filesystem::path _networkDescriptionFilePath
 library network description file path More...
 
boost::filesystem::path _licenseFilePath
 library license file path
 
boost::filesystem::path _productLogoFilePath
 product logo file path
 
boost::filesystem::path _companyLogoFilePath
 company logo file path
 
bool _bNetworkCapabilitiesInhibited
 
bool _bInit
 

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

User configuration for IPSDK library.

Author
E. Noirfalise
Date
2014/09/10
Copyright
2014 Reactiv'IP, all right reserved.

All these values are optionnal and are defaulted on initialization

Member Function Documentation

◆ getProjectRootDirectory()

const boost::filesystem::path& ipsdk::core::LibraryUserConfiguration::getProjectRootDirectory ( ) const

access to project root directory

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

◆ setProjectRootDirectory()

void ipsdk::core::LibraryUserConfiguration::setProjectRootDirectory ( const boost::filesystem::path &  projectRootDirectory)

access to project root directory

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

◆ getLogMainDirPath()

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

access to library log main directory

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

◆ setLogMainDirPath()

void ipsdk::core::LibraryUserConfiguration::setLogMainDirPath ( const boost::filesystem::path &  logMainDirPath)

access to library log main directory

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

◆ getLogMainFileName()

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

access to library main log file name (name with extension)

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

◆ setLogMainFileName()

void ipsdk::core::LibraryUserConfiguration::setLogMainFileName ( const std::string &  logMainFileName)

access to library main log file name (name with extension)

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

◆ isLogDailyRollingFileAppenderUsed()

bool ipsdk::core::LibraryUserConfiguration::isLogDailyRollingFileAppenderUsed ( ) const

access to flag indicating whether a daily rolling file appender is used for main log file

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

◆ setUseLogDailyRollingFileAppender()

void ipsdk::core::LibraryUserConfiguration::setUseLogDailyRollingFileAppender ( const bool  bUseLogDailyRollingFileAppender)

access to flag indicating whether a daily rolling file appender is used for main log file

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

◆ getUserConfigurationDirPath()

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

access to library user configuration directory

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

◆ setUserConfigurationDirPath()

void ipsdk::core::LibraryUserConfiguration::setUserConfigurationDirPath ( const boost::filesystem::path &  userConfigurationDirPath)

access to library user configuration directory

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

◆ getCommonConfigurationDirPath()

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

access to library common (all users) configuration directory

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

◆ setCommonConfigurationDirPath()

void ipsdk::core::LibraryUserConfiguration::setCommonConfigurationDirPath ( const boost::filesystem::path &  commonConfigurationDirPath)

access to library common (all users) configuration directory

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

◆ getTemporaryDirPath()

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

access to library temporary directory

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

◆ setTemporaryDirPath()

void ipsdk::core::LibraryUserConfiguration::setTemporaryDirPath ( const boost::filesystem::path &  temporaryDirPath)

access to library temporary directory

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

◆ getLocalProcessingPolicyFilePath()

const boost::filesystem::path& ipsdk::core::LibraryUserConfiguration::getLocalProcessingPolicyFilePath ( ) const

access to library local processing policy file path

Note
this value may be left empty for automatic configuration
Exceptions
ipsdk::core::IPSDKCoreExceptionif isInit() == false

◆ setLocalProcessingPolicyFilePath()

void ipsdk::core::LibraryUserConfiguration::setLocalProcessingPolicyFilePath ( const boost::filesystem::path &  localProcessingPolicyFilePath)

access to library local processing policy file path

Note
this value may be left empty for automatic configuration
Exceptions
ipsdk::core::IPSDKCoreExceptionif isInit() == false

◆ getDistributedProcessingPolicyFilePath()

const boost::filesystem::path& ipsdk::core::LibraryUserConfiguration::getDistributedProcessingPolicyFilePath ( ) const

access to library distributed processing policy file path

Note
this value may be left empty for automatic configuration
Exceptions
ipsdk::core::IPSDKCoreExceptionif isInit() == false

◆ setDistributedProcessingPolicyFilePath()

void ipsdk::core::LibraryUserConfiguration::setDistributedProcessingPolicyFilePath ( const boost::filesystem::path &  distributedProcessingPolicyFilePath)

access to library distributed processing policy file path

Note
this value may be left empty for automatic configuration
Exceptions
ipsdk::core::IPSDKCoreExceptionif isInit() == false

◆ getNetworkDescriptionFilePath()

const boost::filesystem::path& ipsdk::core::LibraryUserConfiguration::getNetworkDescriptionFilePath ( ) const

access to library network description file path

Note
this value may be left empty in case of local processing only license feature
Exceptions
ipsdk::core::IPSDKCoreExceptionif isInit() == false

◆ setNetworkDescriptionFilePath()

void ipsdk::core::LibraryUserConfiguration::setNetworkDescriptionFilePath ( const boost::filesystem::path &  networkDescriptionFilePath)

access to library network description file path

Note
this value may be left empty in case of local processing only license feature
Exceptions
ipsdk::core::IPSDKCoreExceptionif isInit() == false

◆ getLicenseFilePath()

const boost::filesystem::path& ipsdk::core::LibraryUserConfiguration::getLicenseFilePath ( ) const

access to library license file path

Note
this value may be left empty for default configuration
Exceptions
ipsdk::core::IPSDKCoreExceptionif isInit() == false

◆ setLicenseFilePath()

void ipsdk::core::LibraryUserConfiguration::setLicenseFilePath ( const boost::filesystem::path &  licenseFilePath)

access to library license file path

Note
this value may be left empty for default configuration
Exceptions
ipsdk::core::IPSDKCoreExceptionif isInit() == false

◆ getProductLogoFilePath()

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

access to product logo file path

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

◆ setProductLogoFilePath()

void ipsdk::core::LibraryUserConfiguration::setProductLogoFilePath ( const boost::filesystem::path &  productLogoFilePath)

access to product logo file path

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

◆ getCompanyLogoFilePath()

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

access to company logo file path

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

◆ setCompanyLogoFilePath()

void ipsdk::core::LibraryUserConfiguration::setCompanyLogoFilePath ( const boost::filesystem::path &  companyLogoFilePath)

access to company logo file path

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

Member Data Documentation

◆ _bUseLogDailyRollingFileAppender

bool ipsdk::core::LibraryUserConfiguration::_bUseLogDailyRollingFileAppender
protected

flag indicating whether a daily rolling file appender is used for main log file

◆ _localProcessingPolicyFilePath

boost::filesystem::path ipsdk::core::LibraryUserConfiguration::_localProcessingPolicyFilePath
protected

library local processing policy file path

Note
this value may be left empty for automatic configuration

◆ _distributedProcessingPolicyFilePath

boost::filesystem::path ipsdk::core::LibraryUserConfiguration::_distributedProcessingPolicyFilePath
protected

library distributed processing policy file path

Note
this value may be left empty for automatic configuration

◆ _networkDescriptionFilePath

boost::filesystem::path ipsdk::core::LibraryUserConfiguration::_networkDescriptionFilePath
protected

library network description file path

Note
this value may be left empty in case of local processing only license feature

◆ _bNetworkCapabilitiesInhibited

bool ipsdk::core::LibraryUserConfiguration::_bNetworkCapabilitiesInhibited
protected

flag indicating whether network capabilities should be inibited if presents (default false)

The documentation for this class was generated from the following file:
Generated on Tue Apr 15 2025 16:20:55 for IPSDK by   doxygen 1.8.14