Changeset 889067e

Timestamp:

May 25, 2021, 9:55:52 PM (4 years ago)

Author:

Frederik Heber <frederik.heber@…>

Branches:

Candidate_v1.7.0, stable

Children:

82e5fb

Parents:

4b2207

git-author:

Frederik Heber <frederik.heber@…> (05/25/21 07:02:57)

git-committer:

Frederik Heber <frederik.heber@…> (05/25/21 21:55:52)

Message:

Added force-overwrite to OutputAsAction.

• DOCU: Also added information to userguide.

Files:

• doc/userguide/userguide.xml (modified) (1 diff)
• src/Actions/WorldAction/OutputAsAction.cpp (modified) (1 diff)
• src/Actions/WorldAction/OutputAsAction.def (modified) (2 diffs)
• tests/Python/AllActions/options.dat (modified) (1 diff)

doc/userguide/userguide.xml

@@ -511 +511 @@
           <programlisting>... --output-as world.xyz</programlisting>
           <para>This action on the other hand will be write the current state
-          to a new file "world.xyz".</para>
+          to a new file "world.xyz".</para>
+          <para>By default, this will not overwrite any present files. To
+          overwrite present files, please append 
+          <programlisting>--force-overwrite 1</programlisting>.</para>
         </section>
         <section xml:id="fileparsers.save-selected-molecules">

src/Actions/WorldAction/OutputAsAction.cpp

@@ -68 +68 @@
   }
 
+  if (!params.forceOverwrite.get() && boost::filesystem::exists(params.filename.get())) {
+    STATUS("File "+params.filename.get().string()+" is already present and force-overwrite set to false.");
+    return Action::failure;
+  }
+
   // store file
   // parse the file

src/Actions/WorldAction/OutputAsAction.def

@@ -9 +9 @@
 #
 
+#include "Parameters/Validators/DummyValidator.hpp"
 #include "Parameters/Validators/Ops_Validator.hpp"
-#include "Parameters/Validators/Specific/FilePresentValidator.hpp"
 #include "Parameters/Validators/Specific/ParserFileValidator.hpp"
 
@@ -16 +16 @@
 // ValueStorage by the token "Z" -> first column: int, Z, "Z"
 // "undefine" if no parameters are required, use (NOPARAM_DEFAULT) for each (undefined) default value
-#define paramtypes (boost::filesystem::path)
-#define paramtokens ("output-as")
-#define paramdescriptions ("filename to write to")
-#undef paramdefaults
-#define paramreferences (filename)
+#define paramtypes (boost::filesystem::path)(bool)
+#define paramtokens ("output-as")("force-overwrite")
+#define paramdescriptions ("filename to write to")("overwrite file if already present")
+#define paramdefaults (NOPARAM_DEFAULT)(PARAM_DEFAULT(false))
+#define paramreferences (filename)(forceOverwrite)
 #define paramvalids \
-(!FilePresentValidator() && ParserFileValidator())
+(ParserFileValidator()) \
+(DummyValidator<bool>())
 
 #undef statetypes

tests/Python/AllActions/options.dat

@@ -86 +86 @@
 fill_void       "water.xyz"
 forces_file     "test.forces"
+force_overwrite "0"
 fragment_charges        "1 1"
 fragment_executable     "mpqc"