docs: start writing the S4U part

[simgrid.git] / include / simgrid / s4u / VirtualMachine.hpp

diff --git a/include/simgrid/s4u/VirtualMachine.hpp b/include/simgrid/s4u/VirtualMachine.hpp
index 33f8183..69221c8 100644 (file)
--- a/include/simgrid/s4u/VirtualMachine.hpp
+++ b/include/simgrid/s4u/VirtualMachine.hpp
@@ -8,13 +8,6 @@
 
 #include <simgrid/s4u/Host.hpp>
 
-enum e_surf_vm_state_t {
-  SURF_VM_STATE_CREATED, /**< created, but not yet started */
-  SURF_VM_STATE_RUNNING,
-  SURF_VM_STATE_SUSPENDED, /**< Suspend/resume does not involve disk I/O, so we assume there is no transition states. */
-  SURF_VM_STATE_DESTROYED
-};
-
 namespace simgrid {
 namespace s4u {
 
@@ -31,13 +24,20 @@ class XBT_PUBLIC VirtualMachine : public s4u::Host {
   virtual ~VirtualMachine();
 
 public:
-  explicit VirtualMachine(const char* name, s4u::Host* physical_host, int core_amount);
-  explicit VirtualMachine(const char* name, s4u::Host* physical_host, int core_amount, size_t ramsize);
+  explicit VirtualMachine(std::string name, s4u::Host* physical_host, int core_amount);
+  explicit VirtualMachine(std::string name, s4u::Host* physical_host, int core_amount, size_t ramsize);
 
   // No copy/move
   VirtualMachine(VirtualMachine const&) = delete;
   VirtualMachine& operator=(VirtualMachine const&) = delete;
 
+  enum class state {
+    CREATED, /**< created, but not yet started */
+    RUNNING,
+    SUSPENDED, /**< Suspend/resume does not involve disk I/O, so we assume there is no transition states. */
+    DESTROYED
+  };
+
   simgrid::vm::VirtualMachineImpl* get_impl() { return pimpl_vm_; }
   void start();
   void suspend();
@@ -51,25 +51,38 @@ public:
   void set_ramsize(size_t ramsize);
   void set_bound(double bound);
 
-  e_surf_vm_state_t getState();
+  VirtualMachine::state get_state();
   static simgrid::xbt::signal<void(VirtualMachine&)> on_start;
   static simgrid::xbt::signal<void(VirtualMachine&)> on_started;
   static simgrid::xbt::signal<void(VirtualMachine&)> on_shutdown;
   static simgrid::xbt::signal<void(VirtualMachine&)> on_suspend;
   static simgrid::xbt::signal<void(VirtualMachine&)> on_resume;
+  static simgrid::xbt::signal<void(VirtualMachine&)> on_migration_start;
+  static simgrid::xbt::signal<void(VirtualMachine&)> on_migration_end;
 
   // Deprecated methods
+  /** @deprecated See VirtualMachine::get_state() */
+  XBT_ATTRIB_DEPRECATED_v323("Please use VirtualMachine::get_state()") VirtualMachine::state getState()
+  {
+    return get_state();
+  }
+  /** @deprecated See VirtualMachine::get_impl() */
   XBT_ATTRIB_DEPRECATED_v323("Please use VirtualMachine::get_impl()") simgrid::vm::VirtualMachineImpl* getImpl()
   {
     return pimpl_vm_;
   }
+  /** @deprecated See VirtualMachine::get_pm() */
   XBT_ATTRIB_DEPRECATED_v323("Please use VirtualMachine::get_pm()") simgrid::s4u::Host* getPm() { return get_pm(); }
+  /** @deprecated See VirtualMachine::set_pm() */
   XBT_ATTRIB_DEPRECATED_v323("Please use VirtualMachine::set_pm()") void setPm(simgrid::s4u::Host* pm) { set_pm(pm); }
+  /** @deprecated See VirtualMachine::get_ramsize() */
   XBT_ATTRIB_DEPRECATED_v323("Please use VirtualMachine::get_ramsize()") size_t getRamsize() { return get_ramsize(); }
+  /** @deprecated See VirtualMachine::set_ramsize() */
   XBT_ATTRIB_DEPRECATED_v323("Please use VirtualMachine::set_ramsize()") void setRamsize(size_t ramsize)
   {
     set_ramsize(ramsize);
   }
+  /** @deprecated See VirtualMachine::set_bound() */
   XBT_ATTRIB_DEPRECATED_v323("Please use VirtualMachine::set_bound()") void setBound(double bound) { set_bound(bound); }
 };
 }