Scanframe Modular Application 0.1.0
Loading...
Searching...
No Matches
ProjectData.h
Go to the documentation of this file.
1#pragma once
6#include <ipj/iface/global.h>
9#include <misc/gen/Sustain.h>
10
11namespace sf
12{
13
14// Forward declarations.
15class ProjectWidget;
16class DataFilterList;
17class CustomFields;
18class ScanEntry;
19
25{
26 public:
31
35 ~ProjectData() override;
36
40 void debug();
41
46
51
57 bool read(std::istream& is);
58
64 bool write(std::ostream& os);
65
70
74 QString getStateName();
75
81
177
182
188 bool start(unsigned index);
189
196 bool evaluate(unsigned index, int file_index = -1);
197
204
210 bool moveToQuery(int scan);
211
220 bool moveTo(int scan, int index, double frac = 0.0, bool perp = false);
221
229 bool activate(unsigned index);
230
235 bool suspend();
236
240 bool stop();
241
245 bool abort();
246
251 bool rotate(int scan_entry);
252
258
266 bool finalize(int lock = 0);
267
272 bool isFinalized() const;
273
279
284 bool canStart(int scan_entry);
285
290 bool canStop();
291
296 bool canAbort();
297
303
308 bool canRotate(int scan_entry);
309
314 bool canEvaluate(int scan_entry);
315
321 bool canFinalize(int lock = 0);
322
327 bool canMoveTo();
328
332 void clear();
333
339 IniEnvelope getScanIni(const QString& scan_area);
340
345
351 bool isScanArea(const QString& name);
352
357 void removeScan(unsigned index);
358
364 void moveScan(unsigned src, unsigned dest);
365
371 void swapScan(unsigned idx1, unsigned idx2);
372
377 int indexOf(ScanEntry*) const;
378
384 int getScanListIndex(const ScanMethod* sm) const;
385
391 bool disableProject(bool disable);
392
398 bool storeFilterList(bool rd);
399
404
410
416
422
428
432 void setSelectedScanIndex(int index);
433
439
445
450
455 void setScanBinderName(const QString& name);
456
461
467
473
477 std::string getNamePrefix();
478
482 QString getErrorText();
483
487 DataFilterList* getFilterList();
488
492 QString getMediumName();
493
499
504
509
514 void setReportTemplate(const QString& templ);
515
521
528 void setPartProject(const PartProject* part_project);
529
534
538 void setPartInspection(const PartInspection* part_inspection);
539
544
549 void setWidget(ProjectWidget* project_widget);
550
556
560 QWidget* getViewerParent();
561
567 ScanEntry* getScan(ssize_t index);
568
572 ssize_t getScanCount();
573
578
582 QString getStateName(int state);
583
587 QString getPart() const;
588
595 void setDirty(bool tf = true);
596
601 bool isDirty() const;
602
607
613 std::string getScanMethodName(ssize_t index);
614
619
620 protected:
625
631 bool sustain(const timespec& ts);
632
638 bool process(const timespec& ts);
639
646 bool setError(const QString& error_text);
647
653 bool setState(EState state);
654
659 void attach(ScanEntry* entry);
660
665 void detach(ScanEntry* entry);
666
673 bool storeProfile(IniProfile& ini_profile, bool rd);
674
679 void storeConfig(bool rd);
680
686
690 const IdInfo* getInfo(const std::string& name) const override;
691
695 bool getSetValue(const IdInfo* info, Value* value, Value::vector_type* params, bool flag_set) override;
696
702
707 bool isDataSavingReady() const;
708
709 private:
711 void variableEvent(Variable::EEvent, const Variable&, Variable&, bool);
712
714 void handleInspectionChange(const void*);
715
717 void handlePropertyPageApply(const void* sender);
718
720 enum : int
721 {
722 weDISABLED = 0,
723 weENABLED,
724 weEVENT
725 };
726
731 void setExports(bool var_export);
732
740 void sendCursorEvent(bool btn_dn, Qt::KeyboardModifiers shift, int index, double frac);
741
747 bool getGenericInfoList(StringList& strings);
748
752 void updateScanStateChanges();
753
755 class InformationVariables;
757 InformationVariables* _vars;
759 ProjectWidget* _projectWidget;
761 TVector<ScanEntry*> _scanList;
763 PartProject* _partProject;
765 bool _dirtyFlag;
767 int _activeScanIndex;
769 int _previousScanIndex;
771 int _quitScanIndex;
773 int _dataFileIndex;
775 ScanMethod* _activeScanMethod;
777 EState _state;
779 EState _prevState;
781 EState _resumeState;
783 ElapseTimer _initTimer;
784 //
785 ElapseTimer _changeTimer;
787 QString _errorText;
789 bool _shouldStop;
791 EState _evalPreState;
793 ScanBinder* _scanBinder;
795 ConfigStore _configStore;
797 std::string _namePrefix;
799 std::string _namePrefixCalibPre;
801 std::string _namePrefixCalibPost;
803 Variable::PtrVector _localVars;
805 PartInspection* _partInspection;
807 int _finalized;
809 TCalibrationSets* _calibSets;
811 ReportOptions _reportOptions;
813 QString _reportTemplate;
815 TVariableHandler<ProjectData> _variableHandler;
816
817 friend class ScanEntry;
819};
820
821}// namespace sf
Class to store application configuration. Uses the global application settings or a given ini-file.
Definition ConfigStore.h:17
Timer for turning true when a certain amount of time has passed.
Definition ElapseTimer.h:12
unsigned long long id_type
Type used for the identifying integer (64-bits).
Definition InformationBase.h:30
Class for reading and writing ini-profiles.
Definition IniProfile.h:17
Definition PartInspection.h:11
Definition PartProject.h:10
Definition ProjectDataPropertyPage.h:15
Keeps the project and all scan areas to inspect.
Definition ProjectData.h:25
PartProject * getPartProject() const
Gets the part-project pointer of the current project.
void addPropertyPages(PropertySheetDialog *sheet)
Adds the project property pages to the given property sheet.
InformationTypes::id_type getScanMethodIdOffset()
Gets the scan method id-offset for derived scan methods. Scan methods use the id-offset to determine ...
bool canFinalize(int lock=0)
Checks if it is possible to 'finalize' at the current time. When lock is non-zero regardless force is...
void detach(ScanEntry *entry)
Called from ScanEntry instance to detach itself to this project.
ScanEntry * getSelectedScan()
Gets the selected scan entry pointer.
bool setError(const QString &error_text)
Sets the error state and the SetState function to set the psERROR state. Called from process() to all...
bool isValidPart()
Check if the part this project data is referring to is valid.
void clear()
Clears the all scan entries of the current project.
bool initializeScans()
Initializes all scan methods.
IniEnvelope getScanIni(const QString &scan_area)
Gets an ini file descendant with information about the scan area configuration.
QString getReportTemplate()
Gets the report template file.
void setScanBinderName(const QString &name)
Sets scan-binder name and so change the implementation.
bool canEvaluate(int scan_entry)
Checks if it is possible to 'Evaluate' at the current time.
int getActiveScanIndex()
Gets the active scan entry index.
int getScanListIndex(const ScanMethod *sm) const
Gets scan method entry index in the scan list.
ProjectWidget * getWidget()
Gets the projects frame.
DataFilterList * getFilterList()
Gets the selected or used filter list. (same as global for now)
bool disableProject(bool disable)
Disables or enables project when other is running.
bool canAbort()
Checks if it is possible to 'Abort' at the current time.
void moveScan(unsigned src, unsigned dest)
Moves the scan area in the list from the given source to a destination index.
ssize_t getScanMethodCount()
Gets the amount of available scan methods.
double getScanProgress()
Gets the progress of the current active scan.
bool canRotate(int scan_entry)
Checks if it is possible to 'Rotate' at the current time.
int indexOf(ScanEntry *) const
Gets the index in the scan entry in the list.
bool isDataSavingReady() const
Checks is saving data is completed.
ProjectData()
Default constructor.
bool process(const timespec &ts)
Called from sustain.
void setDirty(bool tf=true)
Set or resets the dirty flag. Calls attached method of the onDirty closure. When dirty the project ca...
const ConfigStore & getConfigStore() const
Gets a fresh copy of the config store.
bool start(unsigned index)
Start scanning at specified index in the list of scans.
bool rotate(int scan_entry)
Starts rotating the scan axis if possible.
~ProjectData() override
Virtual overridden destructor.
bool moveToSysPos(ESystemPosition sp)
Makes the manipulator move to a predefined system position.
int getSelectedScanIndex()
Gets the selected scan entry index.
QString getErrorText()
Gets the last error text set.
void SetReportOptions(ReportOptions options)
Sets the report options of the project.
void swapScan(unsigned idx1, unsigned idx2)
Swaps to scan entries in the list between the 3 given indices.
const TCalibrationSets & getCalibrationSets()
Gets the calibration sets.
bool storeFilterList(bool rd)
Read or writes the filter list file.
bool finalize(int lock=0)
Finalizes the project so it is locked for changes. When lock is non-zero regardless force is used....
bool abort()
Aborts the current active scan method immediately.
QString getStateName()
Gets the name of the current state the project is in.
bool shouldWaitForEvent()
Allows state machines to wait for a user event .
void setWidget(ProjectWidget *project_widget)
Sets the frame.
void debug()
Just for development and debugging.
bool stop()
Signals a stops to the current active scan method.
const IdInfo * getInfo(const std::string &name) const override
Overridden from base class ProjectScriptObject.
ssize_t getScanCount()
Gets the amount of scans in the current scan plan list.
bool moveTo(int scan, int index, double frac=0.0, bool perp=false)
Moves controller to the location on the surface of a scan area.
bool isScanArea(const QString &name)
Gets if the given scan area name exists.
void addModulePropertyPages(PropertySheetDialog *sheet)
Add the module property pages from this project to the given property sheet.
void attach(ScanEntry *entry)
Called from ScanEntry instance to attach itself to this project.
void setPartInspection(const PartInspection *part_inspection)
Sets the part-inspection of this project.
void setPartProject(const PartProject *part_project)
Assigment clears the scan list and sets the part name. This must be done before this instance can be ...
bool read(std::istream &is)
Reads the project from the stream.
ScanEntry * getActiveScan()
Gets the active scan.
bool isDirty() const
Get the dirty flag.
bool getSetValue(const IdInfo *info, Value *value, Value::vector_type *params, bool flag_set) override
Overridden from base class ProjectScriptObject.
bool activate(unsigned index)
Activates the scan method. This makes the mode exports its variables. Only one scan method is activat...
ReportOptions getReportOptions()
Gets the report options of the project.
EState getState()
Gets the current state of the project data state machine.
bool storeProfile(IniProfile &ini_profile, bool rd)
Reads or writes all project data to or from the given ini-profile instance.
void setSelectedScanIndex(int index)
Sets the selected scan entry index enter -1 for none.
bool setState(EState state)
Sets the new state.
bool isFinalized() const
Checks if the project is finalized.
bool evaluate(unsigned index, int file_index=-1)
Starts evaluating.
bool sustain(const timespec &ts)
Handler set using the _sustainEntry.
bool write(std::ostream &os)
Writes the project information to the output stream.
QString getStateName(int state)
Gets the state-machines's name of the given state.
QString getScanBinderName()
Gets current scan-binder name.
bool canStop()
Checks if it is possible to 'Stop' at the current time.
InformationTypes::id_type getScanBinderIdOffset()
Gets the scan method ID offset for the derived scan binder. The scan binder uses the id-offset to det...
ConfigStore getPartStateIni()
Gets an ini file descendant with screen position information.
TSustain< ProjectData > _sustainEntry
Hooks the sustain function into the sustain interface.
Definition ProjectData.h:624
void removeScan(unsigned index)
Removes the scan at the given index.
bool canSuspend()
Checks if it is possible to 'Suspend' at the current time.
bool isRotating()
Checks iof the rotating axis is rotating currently.
QWidget * getViewerParent()
Gets the parent for the scan method viewers.
EState
Project states in the machine.
Definition ProjectData.h:86
@ psFINISHED
Definition ProjectData.h:150
@ psACCOMMODATING
Project is moving to the to a programmed system position.
Definition ProjectData.h:171
@ psSTOPPING
Project is stopping prematurely.
Definition ProjectData.h:158
@ psSUSPENDED
Project is suspend.
Definition ProjectData.h:155
@ psRETREATED
Definition ProjectData.h:146
@ psTOOLCHANGING
Project is moving to the tool change tool position.
Definition ProjectData.h:115
@ psFINISHING
Project is finishing on the scan area.
Definition ProjectData.h:149
@ psRESETTING
Resetting the manipulator and scan binder.
Definition ProjectData.h:166
@ psSUSPENDING
Project is waiting for scan to go into suspend state.
Definition ProjectData.h:153
@ psAPPROACHED
Definition ProjectData.h:120
@ psCHECKING
Scan method is in check positions mode.
Definition ProjectData.h:123
@ psACCOMMODATED
Project arrived at the programmed system position.
Definition ProjectData.h:173
@ psSCANNING
Scan method is scanning.
Definition ProjectData.h:127
@ psEVALUATED
Definition ProjectData.h:137
@ psINITIALIZED
Initializing scan methods succeeded.
Definition ProjectData.h:102
@ psERROR
Definition ProjectData.h:93
@ psEVALUATING
Definition ProjectData.h:136
@ psSTOPPED
Definition ProjectData.h:159
@ psINITIALIZING
Initializing scan methods.
Definition ProjectData.h:100
@ psMOVING
Project is doing a system move.
Definition ProjectData.h:162
@ psINITFAILED
Project failed to initialize.
Definition ProjectData.h:104
@ psPREPARING
Prepare project for next scan area.
Definition ProjectData.h:110
@ psMOVED
Definition ProjectData.h:163
@ psREADY
Project is ready for action.
Definition ProjectData.h:107
@ psREPORTED
finished reporting.
Definition ProjectData.h:142
@ psPREPARED
Project is prepared for next scan area.
Definition ProjectData.h:112
@ psDATASAVING
Scan data is being saved.
Definition ProjectData.h:131
@ psCHECKED
Definition ProjectData.h:124
@ psUNINITIALIZED
Start of the state at project creation.
Definition ProjectData.h:98
@ psDISABLED
When another project is running.
Definition ProjectData.h:95
@ psSCANNED
Definition ProjectData.h:128
@ psREPORTING
Scan method is reporting.
Definition ProjectData.h:140
@ psTOOLCHANGED
Definition ProjectData.h:116
@ psRESUMING
Project is trying to resume from a stop.
Definition ProjectData.h:168
@ psAPPROACHING
Binder is approaching to scan start position.
Definition ProjectData.h:119
@ psRETREATING
Binder is retreating from stop position.
Definition ProjectData.h:145
bool canStart(int scan_entry)
Checks if it is possible to 'Start' at the current time.
void setReportTemplate(const QString &templ)
Sets thew report template file.
bool canInitialize()
Checks if it is possible to 'Initialize' at the current time.
bool canMoveTo()
Checks if the MoveTo function can be executed successfully.
bool initialize()
Initializes or reinitializes the project binder and all its scans.
bool moveToQuery(int scan)
Queries for a surface position by the user.
ScanEntry * addScan()
Gets pointer to a new created scan entry instance.
bool suspend()
Tries to signal the current scan to hold.
ScanBinder * getScanBinder()
Gets the Scan binder derived instance pointer of the implementation.
std::string getScanMethodName(ssize_t index)
Gets the name of scan method at the given index.
std::string getNamePrefix()
Gets the name prefix of the exported parameters.
TClosure< void, void * > onDirty
Closure method to notify changes on the dirty flag. The attached handler is called when a scan of the...
Definition ProjectData.h:520
ScanEntry * getScan(ssize_t index)
Gets the scan entry pointer of the given index.
bool startDataSaving()
Initiates the start of storing data.
void storeConfig(bool rd)
Reads or writes the module configuration information.
PartInspection * getPartInspection() const
Gets the part-inspection of this project.
QString getMediumName()
Gets the medium name of the project like 'water'.
QString getPart() const
Gets the part name of the loaded project.
Object for scripts to interact with the inspection project.
Definition ProjectScriptObject.h:14
Manages all inspection project data.
Definition ProjectWidget.h:20
Dialog containing multiple property pages.
Definition qt/PropertySheetDialog.h:15
Abstract base class for implementing scan binders.
Definition ScanBinder.h:30
Definition ScanEntry.h:12
Definition ScanMethod.h:22
Definition CalibrationSets.h:116
Encapsulates the std::function() template.
Definition TClosure.h:14
Template to make the sustain system call a class method regularly.
Definition Sustain.h:184
Template for linking pointers of member function to Variable instances.
Definition VariableHandler.h:38
Counted vector having additional methods and operators for ease of usage. This template class extends...
Definition TVector.h:19
Value container class able to performing arithmetic functions.
Definition Value.h:19
EEvent
Events send to the handler set with sf::Variable::setHandler.
Definition VariableTypes.h:130
Class for creating and referencing global or local created parameters or settings called variables....
Definition Variable.h:16
#define _IPJ_CLASS
Definition ipj/iface/global.h:35
Definition Application.h:10
ESystemPosition
Fixed system dependent axis positions.
Definition ipj/iface/Namespace.h:239
QFlags< EReportOption > ReportOptions
Reporting option flags.
Definition ipj/iface/Namespace.h:288
Used to create static lookup lists.
Definition ScriptObject.h:62