ScanEntry.h

Go to the documentation of this file.

#pragma once
#include <QObject>
#include <ipj/iface/ProjectModule.h>
#include <ipj/iface/ScanMethod.h>
#include <misc/gen/IniProfile.h>
 
namespace sf
{
 
class ProjectData;
 
class ScanEntry : public QObject
{
  protected:
    // Protected constructor to prevent creation by others then TProjectData
    ScanEntry(ProjectData* prj_data);
 
  public:
    // Destructor.
    ~ScanEntry() override;
    // Easy to use standard type definition.
    typedef TVector<ScanEntry*> TPtrVector;
    typedef TPtrVector::iter_type TPtrIterator;
 
    QString GetDataFileName()
    {
      return FDataFileName;
    }
 
    // Return the pointer of the selected scan method.
    ScanMethod* GetScanMethod()
    {
      return FScanMethod;
    }
 
    // Sets gets the name of the area scanned.
    QString GetScanArea()
    {
      return FScanArea;
    }
 
    // Sets the scan method.
    void SetScanMethodName(const QString& name);
    // Returns the scan method name.
    QString GetScanMethodName() const;
    // Returns the last scan method command.
    QString GetScanMethodCommand() const;
    // Returns the calibration set name of the scan method.
    QString GetScanMethodCalibrationSet() const;
    // Returns the current scan state.
    ScanMethod::EState GetScanState() const;
    // Returns the current scan states name.
    QString GetScanStateName() const;
    // Sets the current scan inspection state and writes it to the inspection profile.
    void SetInspectionState(EInspectionState is);
    // Returns the current scan inspection state name.
    QString GetInspectionStateName() const;
    // Sets the current scan inspection comment and writes it to the inspection profile.
    void SetInspectionComment(QString cmt);
    // Returns the current scan inspection comment from the inspection profile.
    QString GetInspectionComment() const;
    // Returns the user who made this scan.
    QString GetInspectionUserName() const;
    // Returns the time and date the user made this scan.
    QString GetInspectionDateTimeStr() const;
    // Returns the current inspection data filename from the inspection profile.
    void SetInspectionDataFileName(QString filename);
    // Sets the inspection data filename in the inspection profile.
    QString GetInspectionDataFileName() const;
    // Returns the current scan inspection state.
    EInspectionState GetInspectionState() const;
    // Loads a new area scan file with a scan method.
    void SetScanArea(const QString& name);
 
    // Shows this single scan method frame and hides all others.
    bool ShowFrame();
    // Executes a dialog for modifying the inspection comment and state.
    // Returns mrOK when a choice has been made and mrRetry for a rescan.
    int EditInspectionState();
    // Copy only the calibration parameters specified by this entry
    // when it is a pre- or post-calibration scan.
    bool CalibSettings(bool assign);
    // Shows the calibrated settings of this entry.
    void ShowCalibSettings();
    // Writes the filter analysis information to the inspection database.
    // Returns true if anything has been written.
    bool WriteAnalysisInfo();
    // Opens the data file for this instance. When the index is -1 it opens the last one.
    bool OpenDataFile(int fileindex = -1) const;
    // Makes a copy of the other entry. Does not rename only settings are copied.
    void AssignEntry(ScanEntry* se);
    // Makes a copy of the settings passed scan ini file.
    void AssignIni(IniEnvelope& ini);
    // Makes a copy of a template settings.
    bool AssignSelected(bool templ);
 
  protected:
    // Saves the settings in the scan area file from the scan method.
    void SaveMethodSettings(IniEnvelope ini);
    // Loads the settings from the scan area file in to the scan method.
    void LoadMethodSettings(IniEnvelope ini);
    // Creates the scan frame in the project frame if possible and available.
    bool CreateScanFrame();
    // Writes all scan entry data to the profile and returns true on succes.
    bool WriteProfile(IniProfile& ini);
    // Reads all scan entry data from the profile passed.
    bool ReadProfile(IniProfile& ini);
    // Updates the inspection information fields or updates the inspection file.
    void ReadWriteInspectionInfo(bool rd, bool force = false);
    // Updates the cached version of the inspection information.
    bool UpdateInspectionInfo();
 
  private:
    // Holds name of the scan method
    QString FScanMethodName;
    // Holds the owner of this scan entry instance.
    ProjectData* FProjectData;
    // Holds the pointer to the scan method instance when it is created.
    ScanMethod* FScanMethod;
    // Holds the name of the area which is scanned.
    QString FScanArea;
    // Holds the last update scan state.
    ScanMethod::EState FScanState;
    // Holds the last updated inspection state.
    EInspectionState FInspectionState;
    // Special field for the scan binder to attach some additional data.
    void* FBinderData;
    // Holds the last data file name of the scan.
    QString FDataFileName;
    // Holds the cached version of the comment.
    QString FInspectionComment;
    // Holds the cached version of the inspector user name.
    QString FInspectionUserName;
    // Holds the cached version of inspected date time.
    QString FInspectionDateTimeStr;
 
    friend ProjectData;
    friend ScanBinder;
};
 
inline QString ScanEntry::GetInspectionStateName() const
{
  return sf::GetInspectionStateName(FInspectionState);
}
 
inline EInspectionState ScanEntry::GetInspectionState() const
{
  return FInspectionState;
}
 
}// namespace sf