#3725 exportSnapshots : Add optional prefix

ApplicationCode/CommandFileInterface/RicfExportSnapshots.cpp

@@ -31,16 +31,17 @@
 
 CAF_PDM_SOURCE_INIT(RicfExportSnapshots, "exportSnapshots");
 
-namespace caf {
+namespace caf
-    template<>
+{
-    void RicfExportSnapshots::SnapshotsTypeEnum::setUp()
+template<>
-    {
+void RicfExportSnapshots::SnapshotsTypeEnum::setUp()
+{
     addItem(RicfExportSnapshots::ALL, "ALL", "All");
     addItem(RicfExportSnapshots::VIEWS, "VIEWS", "Views");
     addItem(RicfExportSnapshots::PLOTS, "PLOTS", "Plots");
     setDefault(RicfExportSnapshots::ALL);
-    }
 }
+} // namespace caf
 
 //--------------------------------------------------------------------------------------------------
 ///
@@ -48,6 +49,7 @@ namespace caf {
 RicfExportSnapshots::RicfExportSnapshots()
 {
     RICF_InitField(&m_type, "type", RicfExportSnapshots::SnapshotsTypeEnum(), "Type", "", "", "");
+    RICF_InitField(&m_prefix, "prefix", QString(), "Prefix", "", "", "");
 }
 
 //--------------------------------------------------------------------------------------------------
@@ -67,11 +69,11 @@ void RicfExportSnapshots::execute()
     }
     if (m_type == RicfExportSnapshots::VIEWS || m_type == RicfExportSnapshots::ALL)
     {
-        RicSnapshotAllViewsToFileFeature::exportSnapshotOfAllViewsIntoFolder(absolutePathToSnapshotDir);
+        RicSnapshotAllViewsToFileFeature::exportSnapshotOfAllViewsIntoFolder(absolutePathToSnapshotDir, m_prefix);
     }
     if (m_type == RicfExportSnapshots::PLOTS || m_type == RicfExportSnapshots::ALL)
     {
-        RicSnapshotAllPlotsToFileFeature::exportSnapshotOfAllPlotsIntoFolder(absolutePathToSnapshotDir);
+        RicSnapshotAllPlotsToFileFeature::exportSnapshotOfAllPlotsIntoFolder(absolutePathToSnapshotDir, m_prefix);
     }
 
     mainWnd->loadWinGeoAndDockToolBarLayout();

ApplicationCode/CommandFileInterface/RicfExportSnapshots.h

@@ -48,4 +48,5 @@ public:
 
 private:
     caf::PdmField<SnapshotsTypeEnum> m_type;
+    caf::PdmField<QString>           m_prefix;
 };

ApplicationCode/Commands/ExportCommands/RicSnapshotAllPlotsToFileFeature.cpp

@@ -68,7 +68,7 @@ void RicSnapshotAllPlotsToFileFeature::saveAllPlots()
 //--------------------------------------------------------------------------------------------------
 /// 
 //--------------------------------------------------------------------------------------------------
-void RicSnapshotAllPlotsToFileFeature::exportSnapshotOfAllPlotsIntoFolder(QString snapshotFolderName)
+void RicSnapshotAllPlotsToFileFeature::exportSnapshotOfAllPlotsIntoFolder(const QString& snapshotFolderName, const QString& prefix)
 {
     RiaApplication* app = RiaApplication::instance();
 
@@ -91,6 +91,11 @@ void RicSnapshotAllPlotsToFileFeature::exportSnapshotOfAllPlotsIntoFolder(QStrin
         if (viewWindow->isMdiWindow() && viewWindow->viewWidget())
         {
             QString fileName = RicSnapshotFilenameGenerator::generateSnapshotFileName(viewWindow);
+            if (!prefix.isEmpty())
+            {
+                fileName = prefix + fileName;
+            }
+
             fileName.replace(" ", "_");
 
             QString absoluteFileName = caf::Utils::constructFullFileName(absSnapshotPath, fileName, ".png");

ApplicationCode/Commands/ExportCommands/RicSnapshotAllPlotsToFileFeature.h

@@ -32,7 +32,7 @@ class RicSnapshotAllPlotsToFileFeature : public caf::CmdFeature
 public:
     static void saveAllPlots();
 
-    static void exportSnapshotOfAllPlotsIntoFolder(QString snapshotFolderName);
+    static void exportSnapshotOfAllPlotsIntoFolder(const QString& snapshotFolderName, const QString& prefix = "");
 
 protected:
     // Overrides

ApplicationCode/Commands/ExportCommands/RicSnapshotAllViewsToFileFeature.cpp

@@ -70,7 +70,7 @@ void RicSnapshotAllViewsToFileFeature::saveAllViews()
 //--------------------------------------------------------------------------------------------------
 /// 
 //--------------------------------------------------------------------------------------------------
-void RicSnapshotAllViewsToFileFeature::exportSnapshotOfAllViewsIntoFolder(QString snapshotFolderName)
+void RicSnapshotAllViewsToFileFeature::exportSnapshotOfAllViewsIntoFolder(const QString& snapshotFolderName, const QString& prefix)
 {
     RimProject* project = RiaApplication::instance()->project();
 
@@ -114,6 +114,10 @@ void RicSnapshotAllViewsToFileFeature::exportSnapshotOfAllViewsIntoFolder(QStrin
                 viewer->repaint();
 
                 QString fileName = RicSnapshotFilenameGenerator::generateSnapshotFileName(riv);
+                if (!prefix.isEmpty())
+                {
+                    fileName = prefix + fileName;
+                }
 
                 QString absoluteFileName = caf::Utils::constructFullFileName(absSnapshotPath, fileName, ".png");
                 

ApplicationCode/Commands/ExportCommands/RicSnapshotAllViewsToFileFeature.h

@@ -32,7 +32,7 @@ class RicSnapshotAllViewsToFileFeature : public caf::CmdFeature
 public:
     static void    saveAllViews();
 
-    static void    exportSnapshotOfAllViewsIntoFolder(QString snapshotFolderName);
+    static void    exportSnapshotOfAllViewsIntoFolder(const QString& snapshotFolderName, const QString& prefix = "");
 
 protected:
     // Overrides