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/ConfigStore.h>
 
namespace sf
{
 
// Forward declarations of local classes.
class ScanMethod;
class ScanBinder;
class ProjectModule;
class PartProject;
class TPartInspection;
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;
 
    // Returns the scan system designation.
    std::string GetSystemDesignation() const;
    // Sets the scan system designation. Returns value after filtering.
    const std::string& SetSystemDesignation(std::string name);
    // Function for testing and setting the global settings flag which
    // determines the settings file location.
    void SetSettingsGlobal(bool global);
    bool GetSettingsGlobal() const;
    // Function for testing and setting the static filter list flag which
    // determines if the filter list is part of a project.
    void SetFilterListGlobal(bool global);
    bool GetFilterListGlobal() const;
 
    // Returns the system position in a passed coordinate and true on succes.
    bool GetSystemPosition(ESystemPosition sp, gmi::AxesCoord& ac) const;
    const gmi::AxesCoord& GetSystemPosition(ESystemPosition sp) const;
    // Sets the system position from a passed coordinate and returns true on succes.
    bool SetSystemPosition(ESystemPosition sp, const gmi::AxesCoord& ac);
    // Stores and retrieves the system positions from profile.
    bool ReadWriteSystemPositions(bool rd);
 
    // Returns the strings list of all inspected parts.
    void GetInspectionParts(QStringList& parts);
    // Returns the strings list of all inspected part serials.
    void GetInspectionSerials(const QString& part, QStringList& serials);
    // Returns the strings list of all inspected part serial date times.
    void GetInspectionDates(const QString& part, const QString& serial, QStringList& date_times);
    // Returns the directory where the data is located for the passed part inspection.
    QString GetInspectionFileDir(const TPartInspection* part_inspection);
    // Returns the subdirectory where the data is located for the passed part inspection.
    QString GetInspectionFileSubDir(const TPartInspection* pi);
    // Returns true if the passed part inspection exists.
    bool InspectionExists(const TPartInspection* pi) const;
    // Returns true if the passed part inspection exists.
    bool InspectionExists(const QString& part, const QString& serial, const QString& dts) const;
    // Returns the inspection information profile containing
    // inspected area information on found defects and status.
    IniEnvelope GetInspectionIni(const TPartInspection* pi);
    // Returns the calibration set section name.
    std::string GetCalibrationSetSection(ECalibrationType cal_type, const std::string& set_name);
    // Returns the section name in the configuration file.
    std::string GetConfigCalibrationSetSection() const;
    // Returns the available configured calibration set names.
    void GetConfigCalibrationSetNames(QStringList& names) const;
    // Returns the calibration values of the inspection in a strings derived type.
    bool GetInspectionCalibSetValues(
      const TPartInspection* pi,
      // Inspection data entry.
      ECalibrationType cal_type,
      // Type of the calibration.
      const std::string& set_name,
      // Name of the calibration set.
      KeyValues& values
    );
    // Sets the calibration values of the inspection using a strings derived type.
    bool SetInspectionCalibSetValues(
      const TPartInspection* pi,
      // Inspection data entry.
      ECalibrationType cal_type,
      // Type of the calibration.
      const std::string& set_name,
      // Name of the calibration set.
      const KeyValues& values
    );
    // Returns the calibration set names.
    bool GetCalibrationSetNames(
      const TPartInspection* part_inspection,// Inspection data entry.
      ECalibrationType cal_type,// Type of the calibration.
      QStringList& set_names
    );
    // Returns the section name in the ini file for storing or retrieving
    // scan related inspection data.
    std::string GetInspectionAreaIniSection(const std::string& scan_area) const;
    // Returns the section name in the ini file for storing or retrieving
    // scan  related inspection data.
    std::string GetInspectionAnalysisIniSection(const std::string& scan_area, const std::string& name) const;
    // Returns the strings list of the general information.
    bool GetInspectionGeneralInfo(const TPartInspection* pi, KeyValues& info);
    // Returns the strings list of the custom information.
    bool GetInspectionCustomInfo(const TPartInspection* pi, KeyValues& info);
    // Sets the strings list of the custom information.
    bool SetInspectionCustomInfo(const TPartInspection* pi, const KeyValues& info);
    // Returns the strings list of the scan area information.
    bool GetInspectionScanAreaInfo(const TPartInspection* pi, const std::string& scan_area, KeyValues& info);
    // Returns the inspection state of the specified part and scan area.
    EInspectionState GetInspectionState(const TPartInspection* pi, const std::string& scan_area) const;
    // Sets the inspection state of the specified part and scan area.
    bool SetInspectionState(const TPartInspection* pi, const std::string& scan_area, EInspectionState is);
    // Gets the name of the user that is responsible for this area.
    QString GetInspectionUser(const TPartInspection* pi, const std::string& scan_area) const;
    // Sets the name of the user that is responsible for this area.
    bool SetInspectionUser(const TPartInspection* pi, const std::string& scan_area, const std::string& username, const QDateTime& datetime);
    // Returns the data time of the scan area.
    QString GetInspectionDateTimeStr(const TPartInspection* pi, const std::string& scan_area) const;
    // Gets the inspection calibration type.
    ECalibrationType GetInspectionCalType(const TPartInspection* pi, const std::string& scan_area) const;
    // Sets the inspection calibration type.
    bool SetInspectionCalType(const TPartInspection* pi, const std::string& scan_area, ECalibrationType ct);
    // Returns the inspection comment for a scan area.
    QString GetInspectionComment(const TPartInspection* pi, const std::string& scan_area) const;
    // Sets the inspection comment for a scan area.
    bool SetInspectionComment(const TPartInspection* pi, const std::string& scan_area, const std::string& comment);
    // Returns true when the inspection finalized.
    bool IsInspectionFinalized(const TPartInspection* part_inspection) const;
    // Finalizes the inspection.
    bool FinalizeInspection(const TPartInspection* pi, bool reset = false);
    // Returns the inspection data filename for a scan area.
    QString GetInspectionDataFileName(
      const TPartInspection* pi,
      // Inspection part to point out the inspection.
      const std::string& scan_area,
      // scanned area.
      int file_index = -1// Index of one the previous data files.When -1 it returns always the current one.
    ) const;
    // Returns the history of inspected data files on this scan area.
    bool GetInspectionDataFileNames(
      const TPartInspection* pi,
      // Inspection part to point out the inspection.
      const std::string& scan_area,
      // scanned area.
      QStringList& names// Returned values.
    ) const;
    // Sets the inspection data filename for a scan area.
    bool SetInspectionDataFileName(const TPartInspection* pi, const std::string& scan_area, const QString& filename);
    // Return the scan area names.
    bool GetInspectionScanAreas(
      const TPartInspection* pi,// Inspection part to point out the analysis information.
      QStringList& scan_areas// Returned values.
    ) const;
    // Return the analysis names.
    bool GetInspectionAnalysisEntries(
      const TPartInspection* pi,
      // Inspection part to point out the analysis information.
      const std::string& scan_area,
      // Analysed scan area.
      strings& names// Returned values.
    ) const;
    // Returns the inspection analysis information.
    // Returns false if the inspection or the analysis name does not exist.
    bool GetAnalysisInfo(
      const TPartInspection* pi,
      // Inspection part to point out the analysis information.
      const std::string& scan_area,
      // Analysed scan area.
      const std::string& name,
      // Name of the analysis. Is the assigned filter name.
      KeyValues& info// Returned information strings.
    ) const;
    // Sets the inspection analysis information or removes it.
    // Returns false if the inspection does not exist.
    bool SetAnalysisInfo(
      const TPartInspection* pi,
      // Inspection part to point out the analysis information.
      const std::string& scan_area,
      // Analysed scan area.
      const std::string& name,
      // Name of the analysis. Is the assigned filter name.
      const KeyValues& info// Information strings to set or NULL when the name should be deleted.
    );
    // Removes all the analysis information entries.
    bool RemoveAllAnalysisInfo(
      const TPartInspection* pi,
      // Inspection part to point out the analysis information.
      const std::string& scan_area// Analysed scan area.
    );
    // Creates a part inspection entry and returns true on succes to do so.
    // The part and serial are used to create an entry the current datetime
    // is used to fill in the datetime field.
    bool NewPartInspection(const PartProject* pp, TPartInspection* pi);
    // Returns the part project used to create the inspection.
    void GetPartProject(PartProject* pp, const TPartInspection* pi) const;
    // Selects a part from the database.
    // Using a part project object or a string.
    // Returns true if a valid selection was made.
    bool SelectInspectedPart(TPartInspection* pi);
    bool SelectInspectedPart(QString& part);
    // When create is true it selects an inspection from the inspection database.
    // When create is false the part list is filled parts from the project list
    // and the selected part cannot be changed.
    // When true is returned the returned part inspection can be checked
    // for existence. If not it must be created.
    bool SelectInspection(TPartInspection* pi, bool create = false);
 
    // Returns the project profile containing
    IniEnvelope GetProjectCalibIni(const PartProject* part_proj);
    // Returns the calibration values of the project in a strings derived type.
    bool SetProjectCalibSetValues(
      const PartProject* part_proj,
      // Project data entry.
      ECalibrationType cal_type,
      // Type of the calibration.
      const std::string& set_name,
      // Name of the calibration set.
      const KeyValues& values
    );
    // Sets the calibration values of the project using a strings derived type.
    bool GetProjectCalibSetValues(
      const PartProject* part_proj,
      // Project data entry.
      ECalibrationType cal_type,
      // Type of the calibration.
      const std::string& set_name,
      // Name of the calibration set.
      KeyValues& values
    );
    // Sets the database directory and sets the flag FlagDBDirExists.
    // Returns true if the directory exists.
    bool setProjectDataDir(const QString& dir);
    QString getProjectDataDir();
 
    // Returns true if the project directory is valid.
    bool IsProjectDirValid();
    // Assigns all part names to the passed string list.
    void GetProjectParts(QStringList& parts);
    // Gets all part names in a list.
    QStringList GetProjectParts();
    // Assigns all part name s to the passed string list.
    void GetProjects(const QString& part, QStringList& projects);
    // Gets all projects from a given part in a list.
    QStringList GetProjects(const QString& part);
    // Assigns all part name s to the passed string list.
    void GetScans(const QString& part, QStringList& scans);
    // Tests if the given part exists
    bool PartExists(const QString& part) const;
    // Checks if of the given part project the part exists.
    bool PartExists(const PartProject* part_project) const;
    // Assigns all tool names to the passed string list.
    void GetTools(QStringList& tools) const;
    // Assigns all element names to the passed string list.
    void GetElements(QStringList& elements) const;
    // Assigns all element names to the passed string list.
    void GetMaterials(QStringList& materials, EMaterialType mt) const;
    // Returns the settings directory for the passed part.
    // When the part is empty the global directory is returned.
    // The location is depending on the settings globale flag.
    QString GetSettingsDir(const QString& part) const;
    // Assigns all settings names to the passed string list.
    // When the part is empty the global settings are returned.
    void GetSettings(QStringList& names, const QString& part) const;
    // Returns the template directory.
    QString GetTemplateDir() const;
    // Returns the scan area template names.
    void GetScanTemplates(QStringList& names) const;
    // Returns the ini file of a scan area template.
    IniEnvelope GetScanTemplateIni(const QString& name);
    // Creates a new project part name.
    bool NewProjectPart(const QString& part);
    // Checks if the given part project combination exists,
    bool ProjectExists(const QString& part, const QString& project) const;
    bool ProjectExists(const PartProject* pp) const;
    // Checks if the area scan exists.
    bool ScanExists(const QString& part, const QString& scan);
    // Checks if the tool exists.
    bool ToolExists(const QString& tool);
    // Checks if the element exists.
    bool ElementExists(const QString& element);
    // Checks if the element exists.
    bool MaterialExists(const QString& material);
    // Checks if the config settings exists.
    bool SettingsExists(const QString& part, const QString& settings);
    // Returns true when the passed area exists on the part.
    bool GetScanAreaExists(const QString& part, const QString& scan);
    // Returns an inifile containing scan configuration information.
    IniEnvelope GetScanIni(const QString& part, const QString& scan);
    // Returns an inifile containing interface state information.
    QString GetScanStateIniPath(const QString& part, const QString& scan);
    // Returns the inifile containing state information on user interface.
    QString GetPartStateIniPath(const QString& part);
    // Returns an inifile containing settings information.
    // When the part is empty the global ini file is returned.
    IniEnvelope GetSettingsIni(const QString& part, const QString& settings_name);
    // Returns an inifile containing the tool info.
    IniEnvelope GetToolIni(const QString& tool);
    // Returns an inifile containing the element info.
    IniEnvelope GetElementIni(const QString& element);
    // Returns an inifile containing the element info.
    IniEnvelope GetMaterialIni(const QString& material);
    // Returns the inifile containing configuration information.
    IniEnvelope GetConfigIni();
    // Returns the project filename of the specified part and project.
    QString GetProjectFilePath(const PartProject* part_project) const;
    // Returns the filter filepath of the specified part_project.
    QString GetFilterPath(const PartProject* part_project) const;
    // Returns the directory and drive of the passed part_project instance.
    QString GetPartDirectory(const QString& part) const;
    // Returns true if the picture of the passed part was returned in picture.
    QImage getPartPicture(const QString& part);
    // Returns true if the picture of the passed tool was returned in picture.
    bool GetToolPicture(const QString& tool, QImage& picture);
    // Returns true if the picture of the passed tool was returned in picture.
    bool GetElementPicture(const QString& element, QImage& picture);
    // Selects a part from the database.
    // Using a part project object or a string.
    // Returns true if a valid selection was made.
    bool SelectProjectPart(PartProject* part_project);
    bool SelectProjectPart(QString& part);
    // Selects an existing part project.
    bool SelectPartProject(PartProject* part_project);
    // Selects an existing project using the non-visible part.
    bool SelectProject(PartProject* part_project);
 
    // Locally used class.
    typedef TVector<ProjectData*> TProjects;
 
    // Returns the list of open project classes.
    const TProjects& GetOpenProjects() const
    {
      return FProjects;
    };
 
    // Sets the data-storage root directory and sets the flag FlagDataDirExists.
    // Returns true if the directory exists.
    bool setInspectionDataDir(const QString& dir);
    QString getInspectionDataDir();
    // Returns true if data ase directory is valid.
    bool IsInspectionDataDirValid();
 
    // Returns the motion server instance.
    GmiServer* GetMotionServer();
 
    // Deletes controller implementation.
    void DestroyDevices();
    // Adds server property pages to passed property sheet.
    void AddServerPropertyPages(PropertySheetDialog* sheet);
    // Adds project property pages to passed property sheet.
    void AddProjectPropertyPages(PropertySheetDialog* sheet);
 
    // Returns the maximum amount of servers available.
    int GetAcquisitionServerCount() const
    {
      return 2;
    }
 
    // Returns the acquisition server at the passed index.
    RsaServer* GetAcquisitionServer(int index);
    const RsaServer* GetAcquisitionServer(int index) const;
 
    StorageInterface* GetStorage()
    {
      return FStorageServer->getImplementation();
    }
 
    // Returns false if manual control dialog failed because it could not allocate the controller.
    bool ManualControl();
    // Returns the instance pointer to the motion control implementation.
    gmi::Controller* GetController();
    // Returns true if control of the controller can be obtained
    bool ControllerAllocate(const QString& allocator);
    // Frees the controller.
    bool ControllerFree(const QString& allocator);
 
    // Returns true if the controller is allocated.
    bool IsControllerAllocated()
    {
      return FControllerAllocator.length() ? true : false;
    }
 
    // Reports the amount the module is referenced.
    int GetUsageCount()
    {
      return FProjects.count();
    }
 
    // Returns true if the projects could be (re)initialized.
    bool InitializeProjects();
    // Returns true if the projects can be (re)initialized.
    bool CanInitializeProjects();
    // Attach and detach functions for automatic referencing
    // of TProjectData instances.
    void Attach(ProjectData*);
    void Detach(ProjectData*);
 
    // Gets the active project.
    ProjectData* GetActiveProject();
    // Tries to set the passed project to be the active one.
    bool SetActiveProject(ProjectData* project);
 
    // Puts this property page create function in a list.
    void RegisterToolEditor(TAddProjectPropertyPage editor);
    // Puts this property page create function in a list.
    void RegisterElementEditor(TAddProjectPropertyPage editor);
    // Puts this property page create function in a list.
    void RegisterMaterialEditor(TAddProjectPropertyPage editor);
    // Edits a tool using the registered editor property pages.
    // Returns true when changed.
    bool EditTool(const QString& tool);
    // Edits an element using the registered editor property pages.
    // Returns true when changed.
    bool EditElement(const QString& element);
    // Edits a material using the registered editor property pages.
    // Returns true when changed.
    bool EditMaterial(const QString& material);
    // Returns the sound velocity of the passed material.
    bool GetMaterialVelocity(const QString& material, bool shear, double& value);
    // Sets the sound velocities of the passed material.
    bool SetMaterialVelocity(const QString& material, double longitudinal_vel, double shear_vel);
 
    // Hooks a report generator to this interface.
    void RegisterReportGenerator(TGenerateReportEvent handler);
    // Returns true is a report generator has been installed.
    bool HasReportGenerator();
    // Generates a report using the project data and report options.
    bool GenerateReport(ProjectData* data);
    // Returns the possible templates.
    bool GetReportTemplates(QStringList& strings);
 
    // Makes a backup of the inspection data.
    bool BackupInspection(const TPartInspection* part_inspection);
    // Makes a backup of the project data.
    bool BackupProjects();
    // Returns true when a backup the backup function is valid.
    bool IsBackupAvailable() const;
 
  protected:
    // Returns the redirected file path to the module config inifile.
    QString GetConfigProfilePath() const;
    // Handles the apply of property pages.
    void HandlePropertyPage(QObject* sender);
 
  private:
    // Holds the system designation name.
    std::string FSystemDesignation;
    // Holds the pointer to the motion controller implementation.
    gmi::Controller* FController;
    // Holds the motion server.
    GmiServer* FMotionServer;
    // Holds the pointer to the storage device.
    StorageServer* FStorageServer;
    // Holds the instance of the acquisition device server.
    RsaServer* FAcquisitionUtServer;
    // Holds the instance of the acquisition device server.
    RsaServer* FAcquisitionEcServer;
    // Holds the last name successfully assigned storage implementation.
    std::string FStorageName;
    // Holds the last name successfully assigned acquisition implementation.
    std::string FAcquisitionUtName;
    // Holds the last name successfully assigned acquisition implementation.
    std::string FAcquisitionEcName;
    // Holds the last name successfully assigned controller implementation.
    std::string FControllerName;
    // Holds the flag signaling the valid database directory location.
    bool FProjectDataDirExists;
    // Holds the flag signaling the valid data directory location.
    bool FInspectionDataDirExists;
    // Holds the current database directory.
    QString FProjectDataDir;
    // Holds the current data storage directory.
    QString FInspectionDataDir;
    // Holds the redirected module configuration profile path.
    QString FConfigProfilePath;
    // Hold the name of the allocator.
    QString FControllerAllocator;
    // Holds the list of current TProjectData instances.
    TProjects FProjects;
    // Holds pointer to the current active project.
    ProjectData* FActiveProject;
    // Determines the location of the settings file.
    // When 1 the settings files reside in the part directory otherwise
    // in a global settings directory. When -1 the actual value must
    // be read from the configuration file.
    int FSettingsGlobal;
    // Determines if filter list is project or system (global) dependent.
    // When -1 the actual value must still be read from the configuration file.
    int FFilterListGlobal;
    // Array of the system positions.
    gmi::AxesCoord FSystemPositions[spSYSPOS_LASTENTRY];
    // Holds a list of registered editors.
    QList<TAddProjectPropertyPage> FToolEditors, FElementEditors, FMaterialEditors;
    // Hook to the installed report generator handler.
    TGenerateReportEvent FReportGeneratorHook;
    //
    QSettings _settings{ApplicationSettings::global().getSettings()};
    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