document Virtual machines

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

diff --git a/include/simgrid/s4u/VirtualMachine.hpp b/include/simgrid/s4u/VirtualMachine.hpp
index 4dd134d..689afdd 100644 (file)
--- a/include/simgrid/s4u/VirtualMachine.hpp
+++ b/include/simgrid/s4u/VirtualMachine.hpp
@@ -1,4 +1,4 @@
-/* Copyright (c) 2015-2019. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2015-2020. The SimGrid Team. All rights reserved.          */
 
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
@@ -6,6 +6,7 @@
 #ifndef SIMGRID_S4U_VM_HPP
 #define SIMGRID_S4U_VM_HPP
 
+#include <simgrid/forward.h>
 #include <simgrid/s4u/Host.hpp>
 
 namespace simgrid {
@@ -27,9 +28,11 @@ public:
   explicit VirtualMachine(const std::string& name, Host* physical_host, int core_amount);
   explicit VirtualMachine(const std::string& name, Host* physical_host, int core_amount, size_t ramsize);
 
+#ifndef DOXYGEN
   // No copy/move
   VirtualMachine(VirtualMachine const&) = delete;
   VirtualMachine& operator=(VirtualMachine const&) = delete;
+#endif
 
   enum class state {
     CREATED, /**< created, but not yet started */
@@ -43,11 +46,11 @@ public:
   void suspend();
   void resume();
   void shutdown();
-  void destroy();
+  void destroy() override;
 
-  Host* get_pm();
+  Host* get_pm() const;
   void set_pm(Host* pm);
-  size_t get_ramsize();
+  size_t get_ramsize() const;
   void set_ramsize(size_t ramsize);
   void set_bound(double bound);
 
@@ -59,33 +62,6 @@ public:
   static xbt::signal<void(VirtualMachine const&)> on_resume;
   static xbt::signal<void(VirtualMachine const&)> on_migration_start;
   static xbt::signal<void(VirtualMachine const&)> on_migration_end;
-
-#ifndef DOXYGEN
-  // 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()") vm::VirtualMachineImpl* getImpl()
-  {
-    return pimpl_vm_;
-  }
-  /** @deprecated See VirtualMachine::get_pm() */
-  XBT_ATTRIB_DEPRECATED_v323("Please use VirtualMachine::get_pm()") Host* getPm() { return get_pm(); }
-  /** @deprecated See VirtualMachine::set_pm() */
-  XBT_ATTRIB_DEPRECATED_v323("Please use VirtualMachine::set_pm()") void setPm(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); }
-#endif
 };
 } // namespace s4u
 } // namespace simgrid