SWMMVis  6.0.0-alpha.4
Qt6/C++ GIS-based graphical user interface for the SWMMVis engine (6.0.0-alpha.4)
Loading...
Searching...
No Matches
examplesseeder.h
Go to the documentation of this file.
1
20#ifndef OPENSWMMVIS_PROJECT_EXAMPLESSEEDER_H
21#define OPENSWMMVIS_PROJECT_EXAMPLESSEEDER_H
22
23#include <QString>
24#include <QVector>
25
27
30{
31 QString displayName;
32 QString description;
33 QString category;
36 QString openPath;
37 QString sourceRoot;
38 bool isDirectory = false;
39};
40
43QString seedMarkerFileName();
44
49QString installExamplesDir();
50
54QString appDataExamplesDir();
55
65bool copyDirectoryRecursively(const QString &srcDir, const QString &dstDir,
66 QString *err = nullptr);
67
85bool syncFromInstall(const QString &srcDir, const QString &dstDir,
86 const QString &version, QString *err = nullptr);
87
95QString preferredExamplesDir(const QString &version);
96
108QVector<ExampleInfo> discoverExamples(const QString &dir);
109
110} // namespace openswmmvis::project::examples
111
112#endif // OPENSWMMVIS_PROJECT_EXAMPLESSEEDER_H
QString err
Definition inpmeshwriter.cpp:575
Definition examplesseeder.h:26
bool copyDirectoryRecursively(const QString &srcDir, const QString &dstDir, QString *err=nullptr)
Recursively copies srcDir into dstDir (created if missing).
Definition examplesseeder.cpp:74
QString installExamplesDir()
Definition examplesseeder.cpp:52
QString preferredExamplesDir(const QString &version)
Seeds and returns the directory the Welcome panel should scan.
Definition examplesseeder.cpp:153
QString seedMarkerFileName()
Definition examplesseeder.cpp:47
QString appDataExamplesDir()
Definition examplesseeder.cpp:66
bool syncFromInstall(const QString &srcDir, const QString &dstDir, const QString &version, QString *err=nullptr)
Syncs the install payload into the per-user dir.
Definition examplesseeder.cpp:129
QVector< ExampleInfo > discoverExamples(const QString &dir)
Enumerates examples in dir.
Definition examplesseeder.cpp:174
Definition examplesseeder.h:30
QString description
From example.json "description"; may be empty.
Definition examplesseeder.h:32
QString sourceRoot
Directory to copy (dir example) or the single .inp file (flat example).
Definition examplesseeder.h:37
QString category
Definition examplesseeder.h:33
QString displayName
From example.json "name", else prettified file/dir name.
Definition examplesseeder.h:31
bool isDirectory
Directory-per-example vs legacy flat .inp.
Definition examplesseeder.h:38
QString openPath
Absolute path of the .oswp (preferred) or .inp inside sourceRoot.
Definition examplesseeder.h:36