ProjectModule.h

Go to the documentation of this file.

#pragma once
#include <ipj/iface/Namespace.h>
#include <ipj/iface/ProjectConfig.h>
#include <ipj/iface/global.h>
#include <misc/gen/FunctionRegistry.h>
#include <misc/gen/Security.h>
#include <misc/qt/Globals.h>
 
namespace sf
{
 
// Forward declarations of local classes.
class ScanMethod;
class ScanBinder;
class ProjectModule;
class PartProject;
class PartInspection;
class ProjectData;
class TProjectScript;
 
class _IPJ_CLASS ProjectModule final
  : public ProjectConfig
  , InformationTypes
{
  protected:
    ProjectModule();
 
    ~ProjectModule() override;
 
  public:
    bool Initialize();
    //
    void DestroyServers();
 
    // Module security locks.
    Security SecurityConfig;
    Security SecurityProject;
    Security SecurityInspection;
 
    std::string getSystemDesignation() const;
    const std::string& setSystemDesignation(const std::string& name);
 
    void setSettingsGlobal(bool global);
 
    bool getSettingsGlobal() const;
 
    void setFiltersGlobal(bool global);
 
    bool getFiltersGlobal() const;
 
    bool getSystemPosition(ESystemPosition sys_pos, gmi::AxesCoord& coord) const;
 
    const gmi::AxesCoord& getSystemPosition(ESystemPosition sys_pos) const;
 
    bool setSystemPosition(ESystemPosition sp, const gmi::AxesCoord& ac);
 
    bool storeSystemPositions(bool rd);
 
    void getInspectionParts(QStringList& parts);
 
    void getInspectionSerials(const QString& part, QStringList& serials);
 
    void getInspectionDates(const QString& part, const QString& serial, QStringList& date_times);
 
    QString getInspectionFileDir(const PartInspection* part_inspection);
 
    QString getInspectionFileSubDir(const PartInspection* part_inspection);
 
    bool inspectionExists(const PartInspection* pi) const;
 
    bool inspectionExists(const QString& part, const QString& serial, const QString& dts) const;
 
    IniEnvelope getInspectionIni(const PartInspection* pi);
 
    std::string getCalibrationSetSection(ECalibrationType cal_type, const std::string& set_name);
 
    std::string getConfigCalibrationSetSection() const;
 
    void getConfigCalibrationSetNames(QStringList& names) const;
 
    bool getInspectionCalibSetValues(const PartInspection* pi, ECalibrationType cal_type, const std::string& set_name, KeyValues& values);
 
    bool setInspectionCalibSetValues(const PartInspection* pi, ECalibrationType cal_type, const std::string& set_name, const KeyValues& values);
 
    bool getCalibrationSetNames(const PartInspection* part_inspection, ECalibrationType cal_type, QStringList& set_names);
 
    std::string getInspectionAreaIniSection(const std::string& scan_area) const;
 
    std::string getInspectionAnalysisIniSection(const std::string& scan_area, const std::string& name) const;
 
    bool getInspectionGeneralInfo(const PartInspection* pi, KeyValues& info);
 
    bool getInspectionCustomInfo(const PartInspection* pi, KeyValues& info);
 
    bool setInspectionCustomInfo(const PartInspection* pi, const KeyValues& info);
 
    bool getInspectionScanAreaInfo(const PartInspection* pi, const std::string& scan_area, KeyValues& info);
 
    EInspectionState getInspectionState(const PartInspection* pi, const std::string& scan_area) const;
 
    bool setInspectionState(const PartInspection* pi, const std::string& scan_area, EInspectionState is);
 
    QString getInspectionUser(const PartInspection* pi, const std::string& scan_area) const;
 
    bool setInspectionUser(const PartInspection* pi, const std::string& scan_area, const std::string& username, const QDateTime& datetime);
 
    QString getInspectionDateTimeStr(const PartInspection* pi, const std::string& scan_area) const;
 
    ECalibrationType getInspectionCalType(const PartInspection* pi, const std::string& scan_area) const;
 
    bool setInspectionCalType(const PartInspection* pi, const std::string& scan_area, ECalibrationType ct);
 
    QString getInspectionComment(const PartInspection* pi, const std::string& scan_area) const;
 
    bool setInspectionComment(const PartInspection* pi, const std::string& scan_area, const std::string& comment);
 
    bool isInspectionFinalized(const PartInspection* part_inspection) const;
 
    //
    bool finalizeInspection(const PartInspection* pi, bool reset = false);
 
    QString getInspectionDataFileName(const PartInspection* pi, const std::string& scan_area, int file_index = -1) const;
 
    bool getInspectionDataFileNames(const PartInspection* pi, const std::string& scan_area, QStringList& names) const;
 
    bool setInspectionDataFileName(const PartInspection* pi, const std::string& scan_area, const QString& filename);
 
    bool getInspectionScanAreas(const PartInspection* pi, QStringList& scan_areas) const;
 
    bool getInspectionAnalysisEntries(const PartInspection* pi, const std::string& scan_area, string_list& names) const;
 
    bool getAnalysisInfo(const PartInspection* pi, const std::string& scan_area, const std::string& name, KeyValues& info) const;
 
    bool setAnalysisInfo(const PartInspection* pi, const std::string& scan_area, const std::string& name, const KeyValues& info);
 
    bool removeAllAnalysisInfo(const PartInspection* pi, const std::string& scan_area);
 
    bool createPartInspection(const PartProject* pp, PartInspection* pi);
 
    void getPartProject(PartProject* pp, const PartInspection* pi) const;
 
    bool selectInspectedPart(PartInspection* pi);
 
    bool selectInspectedPart(QString& part);
 
    bool selectInspection(PartInspection* pi, bool create = false);
 
    IniEnvelope getProjectCalibIni(const PartProject* part_proj);
 
    bool setProjectCalibSetValues(const PartProject* part_proj, ECalibrationType cal_type, const std::string& set_name, const KeyValues& values);
 
    bool getProjectCalibSetValues(const PartProject* part_proj, ECalibrationType cal_type, const std::string& set_name, KeyValues& values);
 
    bool setProjectDataDir(const QString& dir);
 
    QString getProjectDataDir() const;
 
    bool isProjectDirValid();
 
    void getProjectParts(QStringList& parts);
 
    QStringList getProjectParts();
 
    void getProjects(const QString& part, QStringList& projects);
 
    QStringList getProjects(const QString& part);
 
    void getScans(const QString& part, QStringList& scans);
 
    bool isPart(const QString& part) const;
 
    bool isPart(const PartProject* part_project) const;
 
    void getTools(QStringList& tools) const;
 
    void getElements(QStringList& elements) const;
 
    void getMaterials(QStringList& materials, EMaterialType mt) const;
 
    QString getSettingsDir(const QString& part) const;
 
    void getSettings(QStringList& names, const QString& part) const;
 
    QString getTemplateDir() const;
 
    void getScanTemplates(QStringList& names) const;
 
    IniEnvelope getScanTemplateIni(const QString& name);
 
    bool createProjectPart(const QString& part);
 
    bool isProject(const QString& part, const QString& project) const;
 
    bool isProject(const PartProject* part_project) const;
 
    bool isScanArea(const QString& part, const QString& area_scan);
 
    bool isTool(const QString& tool);
 
    bool isElement(const QString& element);
 
    bool isMaterial(const QString& material);
 
    bool isSettings(const QString& part, const QString& settings);
 
    IniEnvelope getScanIni(const QString& part, const QString& scan_area);
 
    QString getScanStateIniPath(const QString& part, const QString& scan_area);
 
    QString getPartStateIniPath(const QString& part);
 
    IniEnvelope getSettingsIni(const QString& part, const QString& settings_name);
 
    IniEnvelope getToolIni(const QString& tool);
 
    IniEnvelope getElementIni(const QString& element);
 
    IniEnvelope getMaterialIni(const QString& material);
 
    IniEnvelope getConfigIni();
 
    QString getProjectFilePath(const PartProject* part_project) const;
 
    QString getFilterPath(const PartProject* part_project) const;
 
    QString getPartDirectory(const QString& part) const;
 
    QImage getPartPicture(const QString& part);
 
    bool getToolPicture(const QString& tool, QImage& image);
 
    bool getElementPicture(const QString& element, QImage& image);
 
    bool selectProjectPart(PartProject* part_project);
 
    bool selectProjectPart(QString& part);
 
    bool selectPartProject(PartProject* part_project);
 
    bool selectProject(PartProject* part_project);
 
    typedef TVector<ProjectData*> ProjectList;
 
    const ProjectList& getOpenProjects() const;
 
    bool setInspectionDataDir(const QString& dir);
 
    QString getInspectionDataDir();
 
    bool isInspectionDataDirValid();
 
    GmiServer* getMotionServer();
 
    void destroyDevices();
 
    void addServerPropertyPages(PropertySheetDialog* sheet);
 
    void addProjectPropertyPages(PropertySheetDialog* sheet);
 
    int getAcquisitionServerCount() const;
 
    RsaServer* getAcquisitionServer(int index);
 
    const RsaServer* getAcquisitionServer(int index) const;
 
    StorageInterface* getStorage();
 
    bool openManualControlDialog();
 
    gmi::Controller* getController();
 
    bool allocateController(const QString& allocator);
 
    bool freeController(const QString& allocator);
 
    bool isControllerAllocated();
 
    int getUsageCount();
 
    bool initializeProjects();
 
    bool canInitializeProjects();
 
    void attachProjectData(ProjectData*);
 
    void detachProjectData(ProjectData*);
 
    ProjectData* getActiveProject();
 
    bool setActiveProject(ProjectData* project);
 
    void registerToolEditor(TAddProjectPropertyPage editor);
 
    void registerElementEditor(TAddProjectPropertyPage editor);
 
    void registerMaterialEditor(TAddProjectPropertyPage editor);
 
    bool editTool(const QString& tool);
 
    bool editElement(const QString& element);
 
    bool editMaterial(const QString& material);
 
    bool getMaterialVelocity(const QString& material, bool shear, double& value);
 
    bool setMaterialVelocity(const QString& material, double longitudinal_vel, double shear_vel);
 
    void registerReportGenerator(GenerateReportEvent handler);
 
    bool hasReportGenerator();
 
    bool generateReport(ProjectData* project_data);
 
    bool getReportTemplates(QStringList& strings);
 
    bool backupInspection(const PartInspection* part_inspection);
 
    bool backupProjects();
 
    bool isBackupAvailable() const;
 
  protected:
    QString getConfigProfilePath() const;
 
    void handlePropertyPage(QObject* sender);
 
  private:
    std::string _systemDesignation;
    gmi::Controller* _controller;
    GmiServer* _motionServer;
    StorageServer* _storageServer;
    RsaServer* _acquisitionUtServer;
    RsaServer* _acquisitionEcServer;
    std::string _storageName;
    std::string _acquisitionUtName;
    std::string _acquisitionEcName;
    std::string _controllerName;
    bool _projectDataDirExists;
    bool __inspectionDataDirExists;
    QString _projectDataDir;
    QString _inspectionDataDir;
    QString _configProfilePath;
    QString _controllerAllocator;
    ProjectList _projects;
    ProjectData* _activeProject;
    int _settingsGlobal;
    int _filterListGlobal;
    gmi::AxesCoord _systemPositions[spSYSPOS_LASTENTRY];
    QList<TAddProjectPropertyPage> _toolEditors;
    QList<TAddProjectPropertyPage> _elementEditors;
    QList<TAddProjectPropertyPage> _materialEditors;
    GenerateReportEvent _reportGeneratorHook;
    QSettings _settings{getGlobalSettings()};
    FunctionRegistry::Registration<
      bool, const std::string& /*jobname*/, const std::string& /*source*/, const std::string& /*destination*/, const std::string& /*flags*/>
      _backupFunction{"Backup"};
 
    friend void destroyProjectModule();
    friend ProjectModule* getProjectModule();
};
 
}// namespace sf