LibraryUserConfiguration.h

// LibraryUserConfiguration.h:
// ---------------------------
//

#ifndef __IPSDKCORE_LIBRARYUSERCONFIGURATION_H__
#define __IPSDKCORE_LIBRARYUSERCONFIGURATION_H__

// suppression warnings
// warning C4251: 'ipsdk::core::LibraryUserConfiguration::_logMainFileName' : class 'std::basic_string<_Elem,_Traits,_Alloc>' needs to have dll-interface to be used by clients of 
#pragma warning (push)
#pragma warning (disable : 4251)

#include <IPSDKCore/IPSDKCoreExports.h>
#include <IPSDKSerialization/Engine/BaseSerializationObject.h>
#include <IPSDKUtil/BaseTypes.h>

namespace ipsdk {
namespace core {


class IPSDKCORE_API LibraryUserConfiguration : public BaseSerializationObject
{
    // declare serial class
    IPSDK_DECLARE_SERIAL_WITH_COPY(IPSDKCore, LibraryUserConfiguration)

public:
    LibraryUserConfiguration();
    ~LibraryUserConfiguration();

// methods
public:
    bool                                isInit() const;

    void                                init();

    const boost::filesystem::path&      getProjectRootDirectory() const;
    void                                setProjectRootDirectory(const boost::filesystem::path& projectRootDirectory);

    const boost::filesystem::path&      getLogMainDirPath() const;
    void                                setLogMainDirPath(const boost::filesystem::path& logMainDirPath);

    const std::string&                  getLogMainFileName() const;
    void                                setLogMainFileName(const std::string& logMainFileName);

    bool                                isLogDailyRollingFileAppenderUsed() const;
    void                                setUseLogDailyRollingFileAppender(const bool bUseLogDailyRollingFileAppender);

    const boost::filesystem::path&      getUserConfigurationDirPath() const;
    void                                setUserConfigurationDirPath(const boost::filesystem::path& userConfigurationDirPath);

    const boost::filesystem::path&      getCommonConfigurationDirPath() const;
    void                                setCommonConfigurationDirPath(const boost::filesystem::path& commonConfigurationDirPath);

    const boost::filesystem::path&      getTemporaryDirPath() const;
    void                                setTemporaryDirPath(const boost::filesystem::path& temporaryDirPath);

    const boost::filesystem::path&      getLocalProcessingPolicyFilePath() const;
    void                                setLocalProcessingPolicyFilePath(const boost::filesystem::path& localProcessingPolicyFilePath);

    const boost::filesystem::path&      getDistributedProcessingPolicyFilePath() const;
    void                                setDistributedProcessingPolicyFilePath(const boost::filesystem::path& distributedProcessingPolicyFilePath);

    const boost::filesystem::path&      getNetworkDescriptionFilePath() const;
    void                                setNetworkDescriptionFilePath(const boost::filesystem::path& networkDescriptionFilePath);

    const boost::filesystem::path&      getLicenseFilePath() const;
    void                                setLicenseFilePath(const boost::filesystem::path& licenseFilePath);

    const boost::filesystem::path&      getProductLogoFilePath() const;
    void                                setProductLogoFilePath(const boost::filesystem::path& productLogoFilePath);

    const boost::filesystem::path&      getCompanyLogoFilePath() const;
    void                                setCompanyLogoFilePath(const boost::filesystem::path& companyLogoFilePath);

    bool                                isNetworkCapabilitiesInhibited() const;
    void                                setNetworkCapabilitiesInhibited(const bool bNetworkCapabilitiesInhibited);

// attributes
protected:
    boost::filesystem::path     _projectRootDirectory;

    boost::filesystem::path     _logMainDirPath;

    std::string                 _logMainFileName;

    bool                        _bUseLogDailyRollingFileAppender;

    boost::filesystem::path     _userConfigurationDirPath;

    boost::filesystem::path     _commonConfigurationDirPath;

    boost::filesystem::path     _temporaryDirPath;

    boost::filesystem::path     _localProcessingPolicyFilePath;

    boost::filesystem::path     _distributedProcessingPolicyFilePath;

    boost::filesystem::path     _networkDescriptionFilePath;

    boost::filesystem::path     _licenseFilePath;

    boost::filesystem::path     _productLogoFilePath;

    boost::filesystem::path     _companyLogoFilePath;

    bool                        _bNetworkCapabilitiesInhibited;

    // object initialization flag
    bool                        _bInit;
};


inline bool
LibraryUserConfiguration::isInit() const
{
    return _bInit;
}


} // end of namespace core
} // end of namespace ipsdk

#pragma warning (pop)

#endif // __IPSDKCORE_LIBRARYUSERCONFIGURATION_H__