IPSDKCore/html/a14882_source.html

 // LibraryPath.h:
 // --------------
 //

 #ifndef __IPSDKUTIL_LIBRARYPATH_H__
 #define __IPSDKUTIL_LIBRARYPATH_H__

 #include <IPSDKUtil/IPSDKUtilExports.h>
 #include <IPSDKUtil/BaseTypes.h>
 #include <IPSDKUtil/Tools/LibraryPathTypes.h>

 namespace ipsdk {


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

 IPSDKUTIL_API bool
 isSetProjectRootDirectory();

 IPSDKUTIL_API const boost::filesystem::path&
 getProjectRootDirectory();

 IPSDKUTIL_API boost::filesystem::path
 getIPSDKRootDirectory();

 IPSDKUTIL_API boost::filesystem::path
 getIPSDKDirectory(const eInternalDirectory& dirId);

 IPSDKUTIL_API boost::filesystem::path
 getProjectDirectory(const eInternalDirectory& dirId);

 IPSDKUTIL_API boost::filesystem::path
 getSubDirectory(const eInternalDirectory& dirId);

 IPSDKUTIL_API boost::filesystem::path
 getIPSDKDefaultDirectory(const eDefaultExternalDirectory& dirId);

 IPSDKUTIL_API boost::filesystem::path
 getIPSDKDefaultResourcePath(const eDefaultInternalLibraryResourcePath& resId);

 IPSDKUTIL_API boost::filesystem::path
 getProjectDefaultResourceSubPath(const eDefaultInternalLibraryResourcePath& resId);

 IPSDKUTIL_API boost::filesystem::path
 getProjectDefaultResourcePath(const eDefaultInternalLibraryResourcePath& resId);

 IPSDKUTIL_API boost::filesystem::path
 getIPSDKDefaultResourcePath(const eDefaultExternalLibraryResourcePath& resId);


 } // end of namespace ipsdk

 #endif // __IPSDKUTIL_LIBRARYPATH_H__
ipsdk
Main namespace for IPSDK library.
Definition: AlgorithmFunctionEfficiency.h:22

ipsdk::isSetProjectRootDirectory
IPSDKUTIL_API bool isSetProjectRootDirectory()
function allowing to check whether project root directory has been set

ipsdk::getSubDirectory
IPSDKUTIL_API boost::filesystem::path getSubDirectory(const eInternalDirectory &dirId)
retrieve relative subdirectory associated to a given id

ipsdk::eDefaultExternalDirectory
eDefaultExternalDirectory
Enumerate describing IPSDK default external directories.
Definition: LibraryPathTypes.h:43

ipsdk::eInternalDirectory
eInternalDirectory
Enumerate describing IPSDK internal directories.
Definition: LibraryPathTypes.h:29

ipsdk::getProjectDefaultResourcePath
IPSDKUTIL_API boost::filesystem::path getProjectDefaultResourcePath(const eDefaultInternalLibraryResourcePath &resId)
retrieve Project default internal resource file

ipsdk::setProjectRootDirectory
IPSDKUTIL_API void setProjectRootDirectory(const boost::filesystem::path &projectRootDirectory)
function allowing to select project root directory

ipsdk::eDefaultInternalLibraryResourcePath
eDefaultInternalLibraryResourcePath
Enumerate describing default internal library resources path.
Definition: LibraryPathTypes.h:63

BaseTypes.h
Base types for multiplatform compatibility.

ipsdk::getIPSDKDefaultResourcePath
IPSDKUTIL_API boost::filesystem::path getIPSDKDefaultResourcePath(const eDefaultInternalLibraryResourcePath &resId)
retrieve IPSDK default internal resource file

ipsdk::getIPSDKDefaultDirectory
IPSDKUTIL_API boost::filesystem::path getIPSDKDefaultDirectory(const eDefaultExternalDirectory &dirId)
retrieve ipsdk default external directory

IPSDKUTIL_API
#define IPSDKUTIL_API
Import/Export macro for library IPSDKUtil.
Definition: IPSDKUtilExports.h:27

LibraryPathTypes.h
Predefined types for library path management.

IPSDKUtilExports.h
Definition of import/export macro for library.

ipsdk::getIPSDKRootDirectory
IPSDKUTIL_API boost::filesystem::path getIPSDKRootDirectory()
function allowing to retrieve IPSDK installation root directory

ipsdk::eDefaultExternalLibraryResourcePath
eDefaultExternalLibraryResourcePath
Enumerate describing default external library resources path.
Definition: LibraryPathTypes.h:75

ipsdk::getProjectRootDirectory
IPSDKUTIL_API const boost::filesystem::path & getProjectRootDirectory()
function allowing to retrieve project root directory

ipsdk::getProjectDefaultResourceSubPath
IPSDKUTIL_API boost::filesystem::path getProjectDefaultResourceSubPath(const eDefaultInternalLibraryResourcePath &resId)
retrieve Project default internal resource file relative path

ipsdk::getIPSDKDirectory
IPSDKUTIL_API boost::filesystem::path getIPSDKDirectory(const eInternalDirectory &dirId)
retrieve ipsdk internal directory

ipsdk::getProjectDirectory
IPSDKUTIL_API boost::filesystem::path getProjectDirectory(const eInternalDirectory &dirId)
retrieve project internal directory