Datamanager.hpp

#ifndef DM_DATAMANAGER_HPP_INCLUDED
#define DM_DATAMANAGER_HPP_INCLUDED

#ifdef _MSC_VER
  #pragma once
#endif

#include "DM/config.hpp"
#include "DM/AutoLink.hpp" //enable autolink
#include "DM/IDatamanager.hpp"
#include "DM/IAddInfoLayoutFactory.hpp"
#include "DM/IPolylineFactory.hpp"
#include "DM/IPolygonFactory.hpp"
#include "DM/InsertIterator.hpp"
#include "DM/ISpatialIndexFactory.hpp"
#include "DM/IParameterSet.hpp"

DM_NAMESPACE_BEGIN

//forward declaration
class CostumerModuleInterface;


/// Get the DM version
DM_API const char* getVersion();

/// Compares the provided version against the internal DM version
/// \return  1 if internal version is greater than the provided version string
/// \return  0 if internal version is equal than the provided version string
/// \return -1 if internal version is less than the provided version string
DM_API int compareVersion(const char *versionStr);

/// \brief Checks if the provided DM version string is compatible to the internal DM version.
/** 
 * The version is compatible if the internal DM version is equal or newer and no major interface changes
 * have been made (lookup in internal compatibility map):
 * no function, interface, etc. removed and no semantic or behavior changes introduced.
 */
DM_API bool compatibleVersion(const char *versionStr);

/// If the DLL version of DM library and the NG_lib are used in one project, it is HIGHLY RECOMMENDED to 
/// synchronize the two (DLL and local NG_lib) NG_AddInfoLayoutManager objects. Execute the following call 
/// before using any NG_lib object:
/// DM::registerLayoutManager( &NG_AddInfoLayoutManager::h_data() );
/// (This function is not instantiated in the static library to secure that the dynamic library function is called)
DM_API void registerLayoutManager(void *dataHandle);
/// If the DLL version of DM library and the NG_lib are used in one project, it is necessary that synchronize
/// the two static costumer maps. otherwise the costumer/demo information is not handled correctly
/// DM::registerCostumerData( &DM::h_CostumerMap() );
///
DM_API void registerCostumerData(void *dataHandle);



/// Demo API functions 
/** 
 * the datamanager is NOT in demo mode on startup. The demo mode restricts the number of points to 
 * 1 mio points. Points above the limit are ignored during import and manager files with more than 1 
 * mio points cannot be opened.
 */
//DM_API void setDemoMode(void *instance, bool flag = true);

/// returns the demo flag
DM_API bool demoMode(void *instance);

/// Get the maximum number of points that is admissible in demo mode.
DM_API unsigned long long demoModeLimit();

/// Set costumer affiliation which is stored in the manager file
//DM_API void setCostumerAffiliation(void *instance, const char *name, const char *address, bool demoMode = false);

/// Register opals module for providing the corresponding costumer information
DM_API void registerModule(void *instance, CostumerModuleInterface const *data);


/// Licence error code
namespace Licence {
  enum Type {
    ok = 0,           ///< no error. licence ok
    not_available,    ///< licence not available
    not_active_yet,   ///< licence not activate yet
    expired,          ///< licence expired
    embedded_only,    ///< licence valid only for embedded application
    file_not_found,   ///< licence file doesn't exist
    file_inaccessible,///< licence file not accessible
    file_corrupt,     ///< licence file corrupt
    crypto_error,     ///< licence crypto error
    invalid_version,  ///< licence file version error
    invalid_update, ///< licence not valid for this update
    unknown_error     ///< unknown error occurred
  };
}

/// Set full path of licence file in case it is not located in the corresponding default search path (see details below)
/** default search path order
      <Datamanager-DLL-Path>/opals.key
      <Datamanager-DLL-Path>/../cfg/opals.key
      <opals_base-DLL-Path>/opals.key
      <opals_base-DLL-Path>/../cfg/opals.key

    \return true if licence is valid otherwise false (in this case use getLicenceErrorCode/getLicenceErrorText for details)
*/
DM_API bool setLicenceFile(const char *keyfile);
DM_API bool setLicenceFile(const char *keyfile, const char *embeddedSoftware);

///check the result of the licence test
DM_API Licence::Type getLicenceErrorCode();
DM_API const char*   getLicenceErrorText();

DM_NAMESPACE_END

#endif //DM_DATAMANAGER_HPP_INCLUDED