source: src/Actions/FragmentationAction/ParseFragmentResultsAction.cpp@ 2ae247

Action_Thermostats Add_AtomRandomPerturbation Add_FitFragmentPartialChargesAction Add_RotateAroundBondAction Add_SelectAtomByNameAction Added_ParseSaveFragmentResults Adding_Graph_to_ChangeBondActions Adding_MD_integration_tests Adding_StructOpt_integration_tests Automaking_mpqc_open AutomationFragmentation_failures Candidate_v1.5.4 Candidate_v1.6.0 Candidate_v1.6.1 ChangeBugEmailaddress ChangingTestPorts ChemicalSpaceEvaluator Combining_Subpackages Debian_Package_split Debian_package_split_molecuildergui_only Disabling_MemDebug Docu_Python_wait EmpiricalPotential_contain_HomologyGraph EmpiricalPotential_contain_HomologyGraph_documentation Enable_parallel_make_install Enhance_userguide Enhanced_StructuralOptimization Enhanced_StructuralOptimization_continued Example_ManyWaysToTranslateAtom Exclude_Hydrogens_annealWithBondGraph FitPartialCharges_GlobalError Fix_ChargeSampling_PBC Fix_ChronosMutex Fix_FitPartialCharges Fix_FitPotential_needs_atomicnumbers Fix_ForceAnnealing Fix_IndependentFragmentGrids Fix_ParseParticles Fix_ParseParticles_split_forward_backward_Actions Fix_StatusMsg Fix_StepWorldTime_single_argument Fix_Verbose_Codepatterns Fixes ForceAnnealing_goodresults ForceAnnealing_oldresults ForceAnnealing_tocheck ForceAnnealing_with_BondGraph ForceAnnealing_with_BondGraph_continued ForceAnnealing_with_BondGraph_continued_betteresults ForceAnnealing_with_BondGraph_contraction-expansion GeometryObjects Gui_displays_atomic_force_velocity IndependentFragmentGrids IndependentFragmentGrids_IndividualZeroInstances IndependentFragmentGrids_IntegrationTest IndependentFragmentGrids_Sole_NN_Calculation JobMarket_RobustOnKillsSegFaults JobMarket_StableWorkerPool JobMarket_unresolvable_hostname_fix ODR_violation_mpqc_open PartialCharges_OrthogonalSummation PythonUI_with_named_parameters QtGui_reactivate_TimeChanged_changes Recreated_GuiChecks RotateToPrincipalAxisSystem_UndoRedo SaturateAtoms_findBestMatching SaturateAtoms_singleDegree StoppableMakroAction Subpackage_CodePatterns Subpackage_JobMarket Subpackage_LinearAlgebra Subpackage_levmar Subpackage_mpqc_open Subpackage_vmg ThirdParty_MPQC_rebuilt_buildsystem TrajectoryDependenant_MaxOrder TremoloParser_IncreasedPrecision TremoloParser_MultipleTimesteps Ubuntu_1604_changes stable
Last change on this file since 2ae247 was 73a5f7, checked in by Frederik Heber <heber@…>, 8 years ago

Added parsing and saving of fragment results container state.

  • TEST: Added regression test on saving and parsing results, including undo and redo tests.
  • DOCU: Both actions are fully documented.
  • Property mode set to 100644
File size: 5.2 KB
Line 
1/*
2 * Project: MoleCuilder
3 * Description: creates and alters molecular systems
4 * Copyright (C) 2016 Frederik Heber. All rights reserved.
5 *
6 *
7 * This file is part of MoleCuilder.
8 *
9 * MoleCuilder is free software: you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation, either version 2 of the License, or
12 * (at your option) any later version.
13 *
14 * MoleCuilder is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with MoleCuilder. If not, see <http://www.gnu.org/licenses/>.
21 */
22
23/*
24 * ParseFragmentResultsAction.cpp
25 *
26 * Created on: Sep 04, 2016
27 * Author: heber
28 */
29
30// include config.h
31#ifdef HAVE_CONFIG_H
32#include <config.h>
33#endif
34
35// include headers that implement a archive in simple text format
36// and before MemDebug due to placement new
37#include <boost/archive/text_oarchive.hpp>
38#include <boost/archive/text_iarchive.hpp>
39
40#include "CodePatterns/MemDebug.hpp"
41
42#include <iostream>
43
44#include "CodePatterns/Assert.hpp"
45#include "CodePatterns/Log.hpp"
46
47#include "Fragmentation/Summation/Containers/FragmentationResultContainer.hpp"
48
49#include "Actions/FragmentationAction/ParseFragmentResultsAction.hpp"
50
51using namespace MoleCuilder;
52
53// and construct the stuff
54#include "ParseFragmentResultsAction.def"
55#include "Action_impl_pre.hpp"
56/** =========== define the function ====================== */
57
58static void secureFragmentResultsContentsInStream(std::ostream &_backupstream)
59{
60 FragmentationResultContainer& container = FragmentationResultContainer::getInstance();
61 boost::archive::text_oarchive oa(_backupstream);
62 oa << container;
63}
64
65static void restoreFragmentResultsContentsFromStream(std::istream &_backupstream)
66{
67 FragmentationResultContainer& container = FragmentationResultContainer::getInstance();
68 boost::archive::text_iarchive ia(_backupstream);
69 ia >> container;
70}
71
72bool parseFragmentResultsFromFile(
73 const boost::filesystem::path &fragmentresults_file,
74 std::stringstream &_backupstream
75 )
76{
77 /// if file is given, parse from file into ResultsContainer
78 FragmentationResultContainer& container = FragmentationResultContainer::getInstance();
79 // secure container contents
80 secureFragmentResultsContentsInStream(_backupstream);
81 if (boost::filesystem::exists(fragmentresults_file)) {
82 LOG(1, "INFO: Parsing results from " << fragmentresults_file.string() << ".");
83 std::ifstream filestream(fragmentresults_file.string().c_str());
84 if (filestream.good()) {
85 container.clear();
86 restoreFragmentResultsContentsFromStream(filestream);
87 if (filestream.bad()) { // check if correctly written
88 LOG(1, "Failed to read from file " << fragmentresults_file.string() << ".");
89 // restore container
90 restoreFragmentResultsContentsFromStream(_backupstream);
91 return false;
92 } else
93 filestream.close();
94 }
95 } else {
96 ELOG(1, "Given file " << fragmentresults_file.string() << " does not exist.");
97 return false;
98 }
99 return true;
100}
101
102ActionState::ptr FragmentationParseFragmentResultsAction::performCall()
103{
104 if (!params.fragmentresults_file.get().empty()) {
105 const boost::filesystem::path &fragmentresults_file = params.fragmentresults_file.get();
106 std::stringstream backupstream;
107 if (parseFragmentResultsFromFile(fragmentresults_file, backupstream)) {
108 STATUS("SUCCESS: Parsed Fragment results from file "+toString(fragmentresults_file.string())+".");
109 return ActionState::ptr(new FragmentationParseFragmentResultsState(backupstream.str(), params));
110 } else {
111 STATUS("FAIL: Failed to parse fragment results file.");
112 return Action::failure;
113 }
114 } else {
115 STATUS("FAIL: Fragment results file name is empty.");
116 return Action::failure;
117 }
118}
119
120ActionState::ptr FragmentationParseFragmentResultsAction::performUndo(ActionState::ptr _state) {
121 FragmentationParseFragmentResultsState *state =
122 assert_cast<FragmentationParseFragmentResultsState*>(_state.get());
123
124 FragmentationResultContainer& container = FragmentationResultContainer::getInstance();
125 std::stringstream contents(state->streamed_container);
126 boost::archive::text_iarchive ia(contents);
127 ia >> container;
128
129 return ActionState::ptr(_state);
130}
131
132ActionState::ptr FragmentationParseFragmentResultsAction::performRedo(ActionState::ptr _state){
133 FragmentationParseFragmentResultsState *state =
134 assert_cast<FragmentationParseFragmentResultsState*>(_state.get());
135
136 // we know that action suceeded before
137 std::stringstream backupstream;
138 bool status = parseFragmentResultsFromFile(state->params.fragmentresults_file.get(), backupstream);
139 ASSERT( status,
140 "FragmentationParseFragmentResultsAction::performRedo() - action failed although succeeded before?");
141
142 return ActionState::ptr(_state);
143}
144
145bool FragmentationParseFragmentResultsAction::canUndo() {
146 return true;
147}
148
149bool FragmentationParseFragmentResultsAction::shouldUndo() {
150 return true;
151}
152/** =========== end of function ====================== */
Note: See TracBrowser for help on using the repository browser.