Changeset 5adb84 for src/Fragmentation/Automation/FragmentController.hpp

Timestamp:

May 17, 2012, 3:21:12 PM (13 years ago)

Author:

Frederik Heber <heber@…>

Branches:

Action_Thermostats, Add_AtomRandomPerturbation, Add_FitFragmentPartialChargesAction, Add_RotateAroundBondAction, Add_SelectAtomByNameAction, Added_ParseSaveFragmentResults, AddingActions_SaveParseParticleParameters, Adding_Graph_to_ChangeBondActions, Adding_MD_integration_tests, Adding_ParticleName_to_Atom, Adding_StructOpt_integration_tests, AtomFragments, Automaking_mpqc_open, AutomationFragmentation_failures, Candidate_v1.5.4, Candidate_v1.6.0, Candidate_v1.6.1, ChangeBugEmailaddress, ChangingTestPorts, ChemicalSpaceEvaluator, CombiningParticlePotentialParsing, 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_BoundInBox_CenterInBox_MoleculeActions, Fix_ChargeSampling_PBC, Fix_ChronosMutex, Fix_FitPartialCharges, Fix_FitPotential_needs_atomicnumbers, Fix_ForceAnnealing, Fix_IndependentFragmentGrids, Fix_ParseParticles, Fix_ParseParticles_split_forward_backward_Actions, Fix_PopActions, Fix_QtFragmentList_sorted_selection, Fix_Restrictedkeyset_FragmentMolecule, Fix_StatusMsg, Fix_StepWorldTime_single_argument, Fix_Verbose_Codepatterns, Fix_fitting_potentials, Fixes, ForceAnnealing_goodresults, ForceAnnealing_oldresults, ForceAnnealing_tocheck, ForceAnnealing_with_BondGraph, ForceAnnealing_with_BondGraph_continued, ForceAnnealing_with_BondGraph_continued_betteresults, ForceAnnealing_with_BondGraph_contraction-expansion, FragmentAction_writes_AtomFragments, FragmentMolecule_checks_bonddegrees, GeometryObjects, Gui_Fixes, Gui_displays_atomic_force_velocity, ImplicitCharges, IndependentFragmentGrids, IndependentFragmentGrids_IndividualZeroInstances, IndependentFragmentGrids_IntegrationTest, IndependentFragmentGrids_Sole_NN_Calculation, JobMarket_RobustOnKillsSegFaults, JobMarket_StableWorkerPool, JobMarket_unresolvable_hostname_fix, MoreRobust_FragmentAutomation, ODR_violation_mpqc_open, PartialCharges_OrthogonalSummation, PdbParser_setsAtomName, PythonUI_with_named_parameters, QtGui_reactivate_TimeChanged_changes, Recreated_GuiChecks, Rewrite_FitPartialCharges, RotateToPrincipalAxisSystem_UndoRedo, SaturateAtoms_findBestMatching, SaturateAtoms_singleDegree, StoppableMakroAction, Subpackage_CodePatterns, Subpackage_JobMarket, Subpackage_LinearAlgebra, Subpackage_levmar, Subpackage_mpqc_open, Subpackage_vmg, Switchable_LogView, ThirdParty_MPQC_rebuilt_buildsystem, TrajectoryDependenant_MaxOrder, TremoloParser_IncreasedPrecision, TremoloParser_MultipleTimesteps, TremoloParser_setsAtomName, Ubuntu_1604_changes, stable

Children:

1dc209

Parents:

fb2324

git-author:

Frederik Heber <heber@…> (12/10/11 15:17:06)

git-committer:

Frederik Heber <heber@…> (05/17/12 15:21:12)

Message:

Factored out Operation and derived all operations from it.

• a number of subclass of FragmentController that encapsulate each operation.
• Operation contains getEndpointIterator(), handle_FinishOperation() and disconnect().
• Operation now also contains Exitflag that was formerly in FragmentController.
• new derived Operations: ReceiveJobsOperation(), CheckResultsOperation(), SendResultsOperation(), ShutdownOperation() that each contain the connect_..., handle_... functions.
• functions to initiate operation have been placed into these Operation- derived classes as implemented virtual operator().
• most of the required member variables have also been associated with the class that needs them. Getters and Setters have been relayed for the moment.
• each Operation as of now needs ref to connection, host and service. This should be changed and the stuff around getEndpointIterator() refactored along with it.

File:

• src/Fragmentation/Automation/FragmentController.hpp (modified) (2 diffs)

src/Fragmentation/Automation/FragmentController.hpp ¶

@@ -34 +34 @@
 {
 public:
-  FragmentController(boost::asio::io_service& io_service, const std::string& host, const std::string& service);
+  FragmentController(boost::asio::io_service& io_service, const std::string& _host, const std::string& _service);
   ~FragmentController();
 
-  /// Handle completion of a calculate operation.
-  void handle_connect_calc(const boost::system::error_code& e,
-      boost::asio::ip::tcp::resolver::iterator endpoint_iterator);
-
-  /// Handle completion of a CheckResults operation.
-  void handle_connect_check(const boost::system::error_code& e,
-      boost::asio::ip::tcp::resolver::iterator endpoint_iterator);
-
-  /// Handle completion of a GetResults operation.
-  void handle_connect_get(const boost::system::error_code& e,
-      boost::asio::ip::tcp::resolver::iterator endpoint_iterator);
-
-  /// Handle completion of a Shutdown operation.
-  void handle_connect_shutdown(const boost::system::error_code& e,
-      boost::asio::ip::tcp::resolver::iterator endpoint_iterator);
-
-  /// Handle completion of an operation.
-  void handle_FinishOperation(const boost::system::error_code& e);
-
-  /// Callback function when bunch of jobs have been sent.
-  void handle_SendJobs(const boost::system::error_code& e);
-
-  /// Callback function when doneJobs have been received.
-  void handle_ReceiveDoneJobs(const boost::system::error_code& e);
-
-  /// Callback function when results are about to be received.
-  void handle_ReceivingResults(const boost::system::error_code& e);
-
-  /// Callback function when results have been received.
-  void handle_ReceivedResults(const boost::system::error_code& e);
-
-  /// place number of jobs into this controller
-  void addJobs(const std::vector<FragmentJob> &jobs);
-
-  /// prepares the calculation of the results
-  void calculateResults();
-  
-  enum Exitflag_t {
-    OkFlag = 0,
-    ErrorFlag = 255
-  };
+  class Operation {
+  public:
+    Operation(Connection &_connection, const std::string& _host, const std::string& _service);
+    virtual ~Operation();
+  public:
+    /// The Connection to the server.
+    Connection &connection_;
+
+    // virtual function pointer to the operation to do
+    virtual void operator()() = 0;
+
+    /// Handle completion of an operation.
+    void handle_FinishOperation(const boost::system::error_code& e);
+
+    enum Exitflag_t {
+      OkFlag = 0,
+      ErrorFlag = 255
+    };
+
+    // get the exit flag of the last operations
+    size_t getExitflag() const
+    {
+      return Exitflag;
+    }
+
+  protected:
+    /// internal function to resolve host name and ip address
+    boost::asio::ip::tcp::resolver::iterator getEndpointIterator();
+
+    /// internal function to disconnect from server
+    void disconnect();
+
+  protected:
+    /// host name of server
+    const std::string host;
+
+    // service to connect to to
+    const std::string service;
+
+    /// flag of operation to give on program exit
+    enum Exitflag_t Exitflag;
+  };
+
+  class ReceiveJobsOperation : public Operation {
+  public:
+    /// Constructor for class ReceiveJobsOperation.
+    ReceiveJobsOperation(Connection &_connection, const std::string& _host, const std::string& _service) :
+      Operation(_connection, _host, _service) {}
+    /// Destructor for class ReceiveJobsOperation
+    ~ReceiveJobsOperation() {}
+
+  public:
+    /// Placing receive jobs operations into an io_service
+    virtual void operator()();
+
+    /// Handle completion of a calculate operation.
+    void handle_connect_calc(const boost::system::error_code& e,
+        boost::asio::ip::tcp::resolver::iterator endpoint_iterator);
+
+    /// Callback function when bunch of jobs have been sent.
+    void handle_SendJobs(const boost::system::error_code& e);
+
+    /// Handle completion of an operation.
+    void handle_FinishOperation(const boost::system::error_code& e);
+
+    /// internal function to connect to server and send jobs for calculation
+    void connect_calc();
+
+    /// Setter for jobs
+    void addJobs(const std::vector<FragmentJob> &jobs);
+
+    /// Getter for number of size of jobs
+    size_t getPresentJobs() const;
+
+  protected:
+    /// bunch of jobs
+    std::vector<FragmentJob> jobs;
+  };
+
+  struct CheckResultsOperation : public Operation  {
+  public:
+    /// Constructor for class CheckResultsOperation.
+    CheckResultsOperation(Connection &_connection, const std::string& _host, const std::string& _service) :
+      Operation(_connection, _host, _service),
+      doneJobs(0)
+    {}
+    /// Destructor for class CheckResultsOperation
+    ~CheckResultsOperation() {}
+
+  public:
+    // placing receive jobs operations into an io_service
+    virtual void operator()();
+
+    /// Handle completion of a CheckResults operation.
+    void handle_connect_check(const boost::system::error_code& e,
+        boost::asio::ip::tcp::resolver::iterator endpoint_iterator);
+
+    /// Callback function when doneJobs have been received.
+    void handle_ReceiveDoneJobs(const boost::system::error_code& e);
+
+    /// Handle completion of an operation.
+    void handle_FinishOperation(const boost::system::error_code& e);
+
+    /// internal function to connect to server and check done jobs
+    void connect_check();
+
+    /// Getter for doneJobs
+    size_t getDoneJobs() const;
+
+  protected:
+    /// currently calculated results
+    size_t doneJobs;
+  };
+
+  struct SendResultsOperation : public Operation  {
+  public:
+    /// Constructor for class SendResultsOperation.
+    SendResultsOperation(Connection &_connection, const std::string& _host, const std::string& _service) :
+      Operation(_connection, _host, _service) {}
+    /// Destructor for class SendResultsOperation
+    ~SendResultsOperation() {}
+
+  public:
+    // placing receive jobs operations into an io_service
+    virtual void operator()();
+
+    /// Handle completion of a GetResults operation.
+    void handle_connect_get(const boost::system::error_code& e,
+        boost::asio::ip::tcp::resolver::iterator endpoint_iterator);
+
+          /// Callback function when results are about to be received.
+          void handle_ReceivingResults(const boost::system::error_code& e);
+
+          /// Callback function when results have been received.
+          void handle_ReceivedResults(const boost::system::error_code& e);
+
+    /// internal function to connect to server and receive calculated results
+    void connect_get();
+
+    /// Getter for results
+    std::vector<FragmentResult> getResults();
+
+  protected:
+    /// bunch of results
+    std::vector<FragmentResult> results;
+  };
+
+  struct ShutdownOperation : public Operation  {
+  public:
+    /// Constructor for class ShutdownOperation.
+    ShutdownOperation(Connection &_connection, const std::string& _host, const std::string& _service) :
+      Operation(_connection, _host, _service) {}
+    /// Destructor for class ShutdownOperation
+    ~ShutdownOperation() {}
+
+  public:
+    // placing receive jobs operations into an io_service
+    virtual void operator()();
+
+    /// Handle completion of a Shutdown operation.
+    void handle_connect_shutdown(const boost::system::error_code& e,
+        boost::asio::ip::tcp::resolver::iterator endpoint_iterator);
+
+    /// internal function to connect to server and receive calculated results
+    void connect_shutdown();
+
+  };
+
+protected:
+  /// The Connection to the server.
+  Connection connection_;
+
+public:
+
+  ReceiveJobsOperation recjobs;
+  CheckResultsOperation checkres;
+  SendResultsOperation  sendres;
+  ShutdownOperation shutdown;
 
   // get the exit flag of the last operations
   size_t getExitflag() const
   {
-    return Exitflag;
-  }
-
-  /// prepares the receival of the results
-  void obtainResults();
-
-  /// prepares the server's shutdown
-  void shutdown();
+    if (recjobs.getExitflag() != 0)
+      return recjobs.getExitflag();
+    if (checkres.getExitflag() != 0)
+      return checkres.getExitflag();
+    if (sendres.getExitflag() != 0)
+      return sendres.getExitflag();
+    if (shutdown.getExitflag() != 0)
+      return shutdown.getExitflag();
+    return 0;
+  }
+
+  /// place number of jobs into this controller
+  void addJobs(const std::vector<FragmentJob> &jobs)
+  {
+    recjobs.addJobs(jobs);
+  }
 
   /// get the results for the current jobs
-  std::vector<FragmentResult> getResults();
-
-  /// get the number of finished results for the current jobs
-  void checkResults();
+  std::vector<FragmentResult> getResults()
+  {
+    return sendres.getResults();
+  }
 
   /// Getter for doneJobs
-  size_t getDoneJobs() const;
+  size_t getDoneJobs() const
+  {
+    return checkres.getDoneJobs();
+  }
 
   /// Getter for number of jobs in the queue
-  size_t getPresentJobs() const;
+  size_t getPresentJobs() const
+  {
+    return recjobs.getPresentJobs();
+  }
 
 private:
-  /// internal function to resolve host name and ip address
-  boost::asio::ip::tcp::resolver::iterator getEndpointIterator();
-
-  /// internal function to connect to server and send jobs for calculation
-  void connect_calc();
-
-  /// internal function to connect to server and check done jobs
-  void connect_check();
-
-  /// internal function to connect to server and receive calculated results
-  void connect_get();
-
-  /// internal function to connect to server and receive calculated results
-  void connect_shutdown();
-
-  /// internal function to disconnect from server
-  void disconnect();
-
-private:
-  /// The Connection to the server.
-  Connection connection_;
-
   /// host name of server
   const std::string host;
@@ -131 +260 @@
   // service to connect to to
   const std::string service;
-
-  /// bunch of jobs
-  std::vector<FragmentJob> jobs;
-
-  /// flag to give on program exit
-  enum Exitflag_t Exitflag;
-
-  /// bunch of results
-  std::vector<FragmentResult> results;
-
-  /// currently calculated results
-  size_t doneJobs;
 };