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

Singleton instance used to initialized IPSDK library features. More...

#include <LibraryInitializer.h>

Inheritance diagram for ipsdk::core::LibraryInitializer:

Public Member Functions

bool isInit () const
 retrieve object initialization flag
 
LibInitResult preinit (const std::string &preInitParamStr)
 pre-initialization method for library
 
LibInitResult init (const bool bFromPython=false)
 initialization method for library
 
LibInitResult init (const char *pLicenseFilePath)
 initialization method for library
 
LibInitResult init (const LibraryUserConfiguration &libraryUserConfiguration, const bool bActivateGpuSupport=true, const bool bFromPython=false, const boost::filesystem::path &licenseFilePath="")
 initialization method for library with custom user configuration More...
 
const boost::filesystem::path & getLocalProcessingPolicyFilePath () const
 retrieve local processing policy file path used for initialization More...
 
const boost::filesystem::path & getDistributedProcessingPolicyFilePath () const
 retrieve distributed processing policy file path used for initialization More...
 
const boost::filesystem::path & getNetworkDescriptionFilePath () const
 retrieve network description file path used for initialization More...
 
const boost::filesystem::path & getLicenseFilePath () const
 retrieve license file path used for initialization More...
 
const eLocalProcessorTypegetLocalProcessorType () const
 retrieve local computer processor type More...
 
void registerDiskImage (const boost::filesystem::path &filePath)
 register a disk image automatically allocated
 
void unRegisterDiskImage (const boost::filesystem::path &filePath)
 unregister a disk image automatically allocated
 
void clear ()
 clear library features
 

Static Public Member Functions

static LibraryInitializergetInstance ()
 retrieve single instance of object
 

Protected Member Functions

BoolResult initLoggers (const LibraryUserConfiguration &libraryUserConfiguration)
 method allowing to initialize loggers for library
 
BoolResult initLicenseManager (const LibraryUserConfiguration &libraryUserConfiguration, const bool bFromPython, const boost::filesystem::path &licenseFilePath)
 method allowing to initialize license manager for library
 
BoolResult initLocalConfiguration (const LibraryUserConfiguration &libraryUserConfiguration)
 method allowing to initialize local computer configuration
 
LibInitResult initNetworkDescription (const LibraryUserConfiguration &libraryUserConfiguration)
 method allowing to initialize network description for library
 
BoolResult removeDiskImages ()
 delete the disk images automatically created
 
void clearInternal ()
 internal clear method for object
 
Constructors and destructors
 LibraryInitializer ()
 
 ~LibraryInitializer ()
 

Protected Attributes

boost::filesystem::path _localProcessingPolicyFilePath
 local processing policy file path used for initialization
 
boost::filesystem::path _distributedProcessingPolicyFilePath
 distributed processing policy file path used for initialization
 
boost::filesystem::path _networkDescriptionFilePath
 network description file path used for initialization
 
boost::filesystem::path _licenseFilePath
 license file path used for initialization
 
eLocalProcessorType _localProcessorType
 local computer processor type
 
bool _bInit
 object initialization flag
 
std::string _preInitParamStr
 Parameter of pre-initialization step.
 
std::vector< boost::filesystem::path > _vDiskImgPaths
 

Detailed Description

Singleton instance used to initialized IPSDK library features.

Author
E. Noirfalise
Date
2013/12/2

Member Function Documentation

◆ init()

LibInitResult ipsdk::core::LibraryInitializer::init ( const LibraryUserConfiguration libraryUserConfiguration,
const bool  bActivateGpuSupport = true,
const bool  bFromPython = false,
const boost::filesystem::path &  licenseFilePath = "" 
)

initialization method for library with custom user configuration

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

◆ getLocalProcessingPolicyFilePath()

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

retrieve local processing policy file path used for initialization

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

◆ getDistributedProcessingPolicyFilePath()

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

retrieve distributed processing policy file path used for initialization

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

◆ getNetworkDescriptionFilePath()

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

retrieve network description file path used for initialization

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

◆ getLicenseFilePath()

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

retrieve license file path used for initialization

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

◆ getLocalProcessorType()

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

retrieve local computer processor type

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

Member Data Documentation

◆ _vDiskImgPaths

std::vector<boost::filesystem::path> ipsdk::core::LibraryInitializer::_vDiskImgPaths
protected

List of the disk image paths automatocally created by the image factory with the default disk image accessor AutoDiskImageAccessor


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