CGMEngineDynamicLoader.hpp

Go to the documentation of this file.

#ifndef CGM_ENGINE_DYNAMIC_LOADER_HPP
#define CGM_ENGINE_DYNAMIC_LOADER_HPP

#include "CubitDynamicLoader.hpp"
#include "CubitString.hpp"
#include "CGMGeomConfigure.h"

class GeometryQueryEngine;
class GeometryModifyEngine;
  
class CUBIT_GEOM_EXPORT CGMEngineDynamicLoader
{
  public:
    CGMEngineDynamicLoader(const CubitString& engine_name);
    virtual ~CGMEngineDynamicLoader();
    
    CubitString get_engine_name();
    
    void set_library_base_name(const CubitString& libname);
    CubitString get_library_base_name();

    CubitBoolean engine_exists();
    
    CubitStatus load_engine();
    CubitStatus unload_engine();
    
    GeometryQueryEngine* get_gqe();
    
    GeometryModifyEngine* get_gme();

  protected:

    // the name of the engine
    const CubitString mEngineName;

    // the filename of the engine library
    CubitString mEngineLibrary;

    // the handle of the engine library
    CubitDynamicLoader::LibraryHandle mLibraryHandle;
    
    // whether attempted to load the library
    CubitBoolean mLoadAttempted; 
    
    // compare versions of CGM that the engine was built with
    // and the version that is expected to be found
    CubitBoolean check_engine_version();

    GeometryQueryEngine* mQueryEngine;
    GeometryModifyEngine* mModifyEngine;
};


// macro to define symbols in CGM engine to allow 
// this dynamic loader to resolve

#if defined(_WIN32)
#define CGM_EXPORT_ENGINE_SYM __declspec(dllexport)
#else
#define CGM_EXPORT_ENGINE_SYM
#endif

#define CGM_ENGINE_EXPORT_CREATE_GQE(EngineName) \
  extern "C" CGM_EXPORT_ENGINE_SYM const char* dynamic_##EngineName##_get_cgm_version() \
  { \
    return "1.0";  /* TODO -- use real versioning system, or not at all? */  \
  } \
  extern "C" CGM_EXPORT_ENGINE_SYM GeometryQueryEngine* dynamic_##EngineName##_create_gqe()

#define CGM_ENGINE_EXPORT_CREATE_GME(EngineName) \
  extern "C" CGM_EXPORT_ENGINE_SYM GeometryModifyEngine* dynamic_##EngineName##_create_gme() \


#endif // CGM_ENGINE_DYNAMIC_LOADER_HPP