From 537b55f6d4bf8ede2526c2bd6cf79bd38b465dac Mon Sep 17 00:00:00 2001 From: Martin Quinson Date: Wed, 18 Jul 2018 00:26:36 +0200 Subject: [PATCH] doxygen: better handling of deprecated symbols --- include/simgrid/s4u/Activity.hpp | 5 ++++ include/simgrid/s4u/Actor.hpp | 35 ++++++++++++++++++++++- include/simgrid/s4u/Comm.hpp | 8 ++++++ include/simgrid/s4u/ConditionVariable.hpp | 1 + include/simgrid/s4u/Engine.hpp | 26 +++++++++++++++++ include/simgrid/s4u/Exec.hpp | 5 ++++ include/simgrid/s4u/Host.hpp | 22 ++++++++++++-- include/simgrid/s4u/Link.hpp | 17 +++++++++++ include/simgrid/s4u/Mailbox.hpp | 7 +++++ include/simgrid/s4u/Mutex.hpp | 1 + include/simgrid/s4u/NetZone.hpp | 13 +++++++++ include/simgrid/s4u/Storage.hpp | 11 +++++++ include/simgrid/s4u/VirtualMachine.hpp | 7 +++++ 13 files changed, 155 insertions(+), 3 deletions(-) diff --git a/include/simgrid/s4u/Activity.hpp b/include/simgrid/s4u/Activity.hpp index e3da5b28f4..432a52bcdf 100644 --- a/include/simgrid/s4u/Activity.hpp +++ b/include/simgrid/s4u/Activity.hpp @@ -78,16 +78,21 @@ public: /** Retrieve the user data of the Activity */ void* get_user_data() { return user_data_; } + /** @deprecated See Activity::get_state()*/ XBT_ATTRIB_DEPRECATED_v323("Please use Activity::get_state()") Activity::State getState() { return state_; } + /** @deprecated See Activity::get_remaining() */ XBT_ATTRIB_DEPRECATED_v323("Please use Activity::get_remaining()") double getRemains() { return get_remaining(); } + /** @deprecated See Activity::set_remaining() */ XBT_ATTRIB_DEPRECATED_v323("Please use Activity::set_remaining()") Activity* setRemains(double remains) { return set_remaining(remains); } + /** @deprecated See Activity::set_user_data() */ XBT_ATTRIB_DEPRECATED_v323("Please use Activity::set_user_data()") Activity* setUserData(void* data) { return set_user_data(data); } + /** @deprecated See Activity::get_user_data() */ XBT_ATTRIB_DEPRECATED_v323("Please use Activity::get_user_data()") void* getUserData() { return user_data_; } private: diff --git a/include/simgrid/s4u/Actor.hpp b/include/simgrid/s4u/Actor.hpp index 65d9bd6a14..09e3df6803 100644 --- a/include/simgrid/s4u/Actor.hpp +++ b/include/simgrid/s4u/Actor.hpp @@ -282,62 +282,84 @@ public: const char* get_property(std::string key); void set_property(std::string key, std::string value); + /** @deprecated See Actor::create() */ XBT_ATTRIB_DEPRECATED_v323("Please use Actor::create()") static ActorPtr createActor( const char* name, s4u::Host* host, std::function code) { return create(name, host, code); } + /** @deprecated See Actor::create() */ XBT_ATTRIB_DEPRECATED_v323("Please use Actor::create()") static ActorPtr createActor( const char* name, s4u::Host* host, std::function*)> code, std::vector* args) { return create(name, host, code, args); } + /** @deprecated See Actor::create() */ template ::type> XBT_ATTRIB_DEPRECATED_v323("Please use Actor::create()") static ActorPtr createActor( const char* name, s4u::Host* host, F code, Args... args) { return create(name, host, code, std::move(args)...); } + /** @deprecated See Actor::create() */ XBT_ATTRIB_DEPRECATED_v323("Please use Actor::create()") static ActorPtr createActor( const char* name, s4u::Host* host, const char* function, std::vector args) { return create(name, host, function, args); } + /** @deprecated See Actor::is_daemon() */ XBT_ATTRIB_DEPRECATED_v323("Please use Actor::is_daemon()") bool isDaemon() const; + /** @deprecated See Actor::get_name() */ XBT_ATTRIB_DEPRECATED_v323("Please use Actor::get_name()") const simgrid::xbt::string& getName() const { return get_name(); } + /** @deprecated See Actor::get_cname() */ XBT_ATTRIB_DEPRECATED_v323("Please use Actor::get_cname()") const char* getCname() const { return get_cname(); } + /** @deprecated See Actor::get_host() */ XBT_ATTRIB_DEPRECATED_v323("Please use Actor::get_host()") Host* getHost() { return get_host(); } + /** @deprecated See Actor::get_pid() */ XBT_ATTRIB_DEPRECATED_v323("Please use Actor::get_pid()") aid_t getPid() { return get_pid(); } + /** @deprecated See Actor::get_ppid() */ XBT_ATTRIB_DEPRECATED_v323("Please use Actor::get_ppid()") aid_t getPpid() { return get_ppid(); } + /** @deprecated See Actor::is_suspended() */ XBT_ATTRIB_DEPRECATED_v323("Please use Actor::is_suspended()") int isSuspended() { return is_suspended(); } + /** @deprecated See Actor::set_auto_restart() */ XBT_ATTRIB_DEPRECATED_v323("Please use Actor::set_auto_restart()") void setAutoRestart(bool a) { set_auto_restart(a); } + /** @deprecated Please use a std::function for first parameter */ XBT_ATTRIB_DEPRECATED_v323("Please use a std::function for first parameter.") void on_exit( int_f_pvoid_pvoid_t fun, void* data); + /** @deprecated See Actor::on_exit() */ XBT_ATTRIB_DEPRECATED_v323("Please use Actor::on_exit()") void onExit(int_f_pvoid_pvoid_t fun, void* data) { on_exit([fun](int a, void* b) { fun((void*)(intptr_t)a, b); }, data); } + /** @deprecated See Actor::set_kill_time() */ XBT_ATTRIB_DEPRECATED_v323("Please use Actor::set_kill_time()") void setKillTime(double time) { set_kill_time(time); } + /** @deprecated See Actor::get_kill_time() */ XBT_ATTRIB_DEPRECATED_v323("Please use Actor::get_kill_time()") double getKillTime() { return get_kill_time(); } + /** @deprecated See Actor::by_pid() */ XBT_ATTRIB_DEPRECATED_v323("Please use Actor::by_pid()") static ActorPtr byPid(aid_t pid) { return by_pid(pid); } + /** @deprecated See Actor::kill_all() */ XBT_ATTRIB_DEPRECATED_v323("Please use Actor::kill_all()") static void killAll() { kill_all(); } + /** @deprecated See Actor::kill_all() */ XBT_ATTRIB_DEPRECATED_v323("Please use Actor::kill_all() with no parameter") static void killAll( int XBT_ATTRIB_UNUSED resetPid) { kill_all(); } + /** @deprecated See Actor::get_impl() */ XBT_ATTRIB_DEPRECATED_v323("Please use Actor::get_impl()") kernel::actor::ActorImpl* getImpl() { return get_impl(); } + /** @deprecated See Actor::get_property() */ XBT_ATTRIB_DEPRECATED_v323("Please use Actor::get_property()") const char* getProperty(const char* key) { return get_property(key); } + /** @deprecated See Actor::get_properties() */ XBT_ATTRIB_DEPRECATED_v323("Please use Actor::get_properties()") std::map* getProperties() { std::map* res = new std::map(); @@ -346,6 +368,7 @@ public: res->insert(kv); return res; } + /** @deprecated See Actor::get_properties() */ XBT_ATTRIB_DEPRECATED_v323("Please use Actor::get_properties()") void setProperty(const char* key, const char* value) { set_property(key, value); @@ -416,22 +439,32 @@ XBT_PUBLIC bool is_suspended(); /** @brief kill the actor. */ XBT_PUBLIC void exit(); -/** @brief Add a function to the list of "on_exit" functions. */ +/** @deprecated Please use std::function for first parameter */ XBT_ATTRIB_DEPRECATED_v323("Please use std::function for first parameter.") XBT_PUBLIC void on_exit(int_f_pvoid_pvoid_t fun, void* data); +/** @brief Add a function to the list of "on_exit" functions. */ XBT_PUBLIC void on_exit(std::function fun, void* data); /** @brief Migrate the actor to a new host. */ XBT_PUBLIC void migrate(Host* new_host); +/** @deprecated See this_actor::get_name() */ XBT_ATTRIB_DEPRECATED_v323("Please use this_actor::get_name()") XBT_PUBLIC std::string getName(); +/** @deprecated See this_actor::get_cname() */ XBT_ATTRIB_DEPRECATED_v323("Please use this_actor::get_cname()") XBT_PUBLIC const char* getCname(); +/** @deprecated See this_actor::is_maestro() */ XBT_ATTRIB_DEPRECATED_v323("Please use this_actor::is_maestro()") XBT_PUBLIC bool isMaestro(); +/** @deprecated See this_actor::get_pid() */ XBT_ATTRIB_DEPRECATED_v323("Please use this_actor::get_pid()") XBT_PUBLIC aid_t getPid(); +/** @deprecated See this_actor::get_ppid() */ XBT_ATTRIB_DEPRECATED_v323("Please use this_actor::get_ppid()") XBT_PUBLIC aid_t getPpid(); +/** @deprecated See this_actor::get_host() */ XBT_ATTRIB_DEPRECATED_v323("Please use this_actor::get_host()") XBT_PUBLIC Host* getHost(); +/** @deprecated See this_actor::is_suspended() */ XBT_ATTRIB_DEPRECATED_v323("Please use this_actor::is_suspended()") XBT_PUBLIC bool isSuspended(); +/** @deprecated See this_actor::on_exit() */ XBT_ATTRIB_DEPRECATED_v323("Please use this_actor::on_exit()") XBT_PUBLIC void onExit(int_f_pvoid_pvoid_t fun, void* data); +/** @deprecated See this_actor::exit() */ XBT_ATTRIB_DEPRECATED_v324("Please use this_actor::exit()") XBT_PUBLIC void kill(); } diff --git a/include/simgrid/s4u/Comm.hpp b/include/simgrid/s4u/Comm.hpp index f5c4401918..0140476f63 100644 --- a/include/simgrid/s4u/Comm.hpp +++ b/include/simgrid/s4u/Comm.hpp @@ -74,31 +74,39 @@ public: /** Retrieve the mailbox on which this comm acts */ MailboxPtr get_mailbox(); + /** @deprecated See Comm::set_rate() */ XBT_ATTRIB_DEPRECATED_v323("Please use Comm::set_rate()") Activity* setRate(double rate) { return set_rate(rate); } + /** @deprecated See Comm::set_src_data() */ XBT_ATTRIB_DEPRECATED_v323("Please use Comm::set_src_data()") Activity* setSrcData(void* buff) { return set_src_data(buff); } + /** @deprecated See Comm::set_src_data() */ XBT_ATTRIB_DEPRECATED_v323("Please use Comm::set_src_data()") Activity* setSrcData(void* buff, size_t size) { return set_src_data(buff, size); } + /** @deprecated See Comm::set_src_data_size() */ XBT_ATTRIB_DEPRECATED_v323("Please use Comm::set_src_data_size()") Activity* setSrcDataSize(size_t size) { return set_src_data_size(size); } + /** @deprecated See Comm::set_dst_data() */ XBT_ATTRIB_DEPRECATED_v323("Please use Comm::set_dst_data()") Activity* setDstData(void** buff) { return set_dst_data(buff); } + /** @deprecated See Comm::set_dst_data() */ XBT_ATTRIB_DEPRECATED_v323("Please use Comm::set_dst_data()") Activity* setDstData(void** buff, size_t size) { return set_dst_data(buff, size); } + /** @deprecated See Comm::get_dst_data_size() */ XBT_ATTRIB_DEPRECATED_v323("Please use Comm::get_dst_data_size()") size_t getDstDataSize() { return get_dst_data_size(); } + /** @deprecated See Comm::get_mailbox() */ XBT_ATTRIB_DEPRECATED_v323("Please use Comm::get_mailbox()") MailboxPtr getMailbox() { return get_mailbox(); } private: diff --git a/include/simgrid/s4u/ConditionVariable.hpp b/include/simgrid/s4u/ConditionVariable.hpp index cf869399d1..06037981ee 100644 --- a/include/simgrid/s4u/ConditionVariable.hpp +++ b/include/simgrid/s4u/ConditionVariable.hpp @@ -36,6 +36,7 @@ public: static Ptr create(); + /** @deprecated See Comm::get_mailbox() */ XBT_ATTRIB_DEPRECATED_v323("Please use Comm::get_mailbox()") Ptr createConditionVariable() { return create(); } // Wait functions without time: diff --git a/include/simgrid/s4u/Engine.hpp b/include/simgrid/s4u/Engine.hpp index dc400f0710..27445d9702 100644 --- a/include/simgrid/s4u/Engine.hpp +++ b/include/simgrid/s4u/Engine.hpp @@ -156,86 +156,109 @@ private: //////////////// Deprecated functions public: + /** @deprecated See Engine::load_platform() */ XBT_ATTRIB_DEPRECATED_v323("Please use Engine::load_platform()") void loadPlatform(std::string platf) { load_platform(platf); } + /** @deprecated See Engine::register_function() */ XBT_ATTRIB_DEPRECATED_v323("Please use Engine::register_function()") void registerFunction(std::string name, int (*code)(int, char**)) { register_function(name, code); } + /** @deprecated See Engine::register_default() */ XBT_ATTRIB_DEPRECATED_v323("Please use Engine::register_default()") void registerDefault(int (*code)(int, char**)) { register_default(code); } + /** @deprecated See Engine::register_actor() */ template XBT_ATTRIB_DEPRECATED_v323("Please use Engine::register_actor()") void registerFunction(std::string name) { register_actor(name); } + /** @deprecated See Engine::register_actor() */ template XBT_ATTRIB_DEPRECATED_v323("Please use Engine::register_actor()") void registerFunction(std::string name, F code) { register_actor(name, code); } + /** @deprecated See Engine::load_deployment() */ XBT_ATTRIB_DEPRECATED_v323("Please use Engine::load_deployment()") void loadDeployment(std::string deploy) { load_deployment(deploy); } + /** @deprecated See Engine::host_by_name() */ XBT_ATTRIB_DEPRECATED_v323("Please use Engine::host_by_name()") simgrid::s4u::Host* hostByName(std::string name) { return host_by_name(name); } + /** @deprecated See Engine::host_by_name_or_null() */ XBT_ATTRIB_DEPRECATED_v323("Please use Engine::host_by_name_or_null()") simgrid::s4u::Host* hostByNameOrNull( std::string name) { return host_by_name_or_null(name); } + /** @deprecated See Engine::storage_by_name() */ XBT_ATTRIB_DEPRECATED_v323("Please use Engine::storage_by_name()") simgrid::s4u::Storage* storageByName( std::string name) { return storage_by_name(name); } + /** @deprecated See Engine::storage_by_name_or_null() */ XBT_ATTRIB_DEPRECATED_v323("Please use Engine::storage_by_name_or_null()") simgrid::s4u::Storage* storageByNameOrNull( std::string name) { return storage_by_name_or_null(name); } + /** @deprecated See Engine::get_host_count() */ XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_host_count()") size_t getHostCount() { return get_host_count(); } + /** @deprecated See Engine::get_all_hosts() */ XBT_ATTRIB_DEPRECATED_v322("Please use Engine::get_all_hosts()") void getHostList(std::vector* whereTo); + /** @deprecated See Engine::get_all_hosts() */ XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_all_hosts()") std::vector getAllHosts() { return get_all_hosts(); } + /** @deprecated See Engine::get_link_count() */ XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_link_count()") size_t getLinkCount() { return get_link_count(); } + /** @deprecated See Engine::get_all_links() */ XBT_ATTRIB_DEPRECATED_v322("Please use Engine::get_all_links()") void getLinkList(std::vector* list); + /** @deprecated See Engine::get_link_list() */ XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_link_list()") std::vector getAllLinks() { return get_all_links(); } + /** @deprecated See Engine::get_all_storages() */ XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_all_storages()") std::vector getAllStorages() { return get_all_storages(); } + /** @deprecated See Engine::get_clock() */ XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_clock()") static double getClock() { return get_clock(); } + /** @deprecated See Engine::get_all_netpoints() */ XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_all_netpoints()") void getNetpointList( std::vector* list); + /** @deprecated See Engine::netpoint_by_name_or_null() */ XBT_ATTRIB_DEPRECATED_v323("Please use Engine::netpoint_by_name_or_null()") simgrid::kernel::routing::NetPoint* getNetpointByNameOrNull(std::string name) { return netpoint_by_name_or_null(name); } + /** @deprecated See Engine::get_netzone_root() */ XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_netzone_root()") simgrid::s4u::NetZone* getNetRoot() { return get_netzone_root(); } + /** @deprecated See Engine::netzone_by_name_or_null() */ XBT_ATTRIB_DEPRECATED_v323( "Please use Engine::netzone_by_name_or_null()") simgrid::s4u::NetZone* getNetzoneByNameOrNull(std::string name) { return netzone_by_name_or_null(name); } + /** @deprecated See Engine::filter_netzones_by_type() */ template XBT_ATTRIB_DEPRECATED_v323("Please use Engine::filter_netzones_by_type()") void getNetzoneByType( std::vector* whereto) @@ -243,14 +266,17 @@ public: get_filtered_netzones_recursive(get_netzone_root(), whereto); } + /** @deprecated See Engine::get_instance() */ XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_instance()") static s4u::Engine* getInstance() { return get_instance(); } + /** @deprecated See Engine::is_initialized() */ XBT_ATTRIB_DEPRECATED_v323("Please use Engine::is_initialized()") static bool isInitialized() { return is_initialized(); } + /** @deprecated See Engine::set_config() */ XBT_ATTRIB_DEPRECATED_v323("Please use Engine::set_config()") void setConfig(std::string str) { set_config(str); } }; diff --git a/include/simgrid/s4u/Exec.hpp b/include/simgrid/s4u/Exec.hpp index ca7ed9264f..afb88e1463 100644 --- a/include/simgrid/s4u/Exec.hpp +++ b/include/simgrid/s4u/Exec.hpp @@ -37,13 +37,18 @@ public: double get_remaining_ratio(); //////////////// Deprecated functions + /** @deprecated See Exec::set_priority() */ XBT_ATTRIB_DEPRECATED_v323("Please use Exec::set_priority()") ExecPtr setPriority(double priority) { return set_priority(priority); } + /** @deprecated See Exec::set_bound() */ XBT_ATTRIB_DEPRECATED_v323("Please use Exec::set_bound()") ExecPtr setBound(double bound) { return set_bound(bound); } + /** @deprecated See Exec::set_host() */ XBT_ATTRIB_DEPRECATED_v323("Please use Exec::set_host()") ExecPtr setHost(Host* host) { return set_host(host); } + /** @deprecated See Exec::get_host() */ XBT_ATTRIB_DEPRECATED_v323("Please use Exec::get_host()") Host* getHost() { return get_host(); } + /** @deprecated See Exec::get_remaining_ratio() */ XBT_ATTRIB_DEPRECATED_v323("Please use Exec::get_remaining_ratio()") double getRemainingRatio() { return get_remaining_ratio(); diff --git a/include/simgrid/s4u/Host.hpp b/include/simgrid/s4u/Host.hpp index f8933b275f..4098162236 100644 --- a/include/simgrid/s4u/Host.hpp +++ b/include/simgrid/s4u/Host.hpp @@ -95,6 +95,7 @@ public: const char* get_property(std::string key) const; void set_property(std::string key, std::string value); std::unordered_map* get_properties(); + /** @deprecated See Host::get_properties() */ XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_properties()") std::map* getProperties() { std::map* res = new std::map(); @@ -114,7 +115,9 @@ public: void set_pstate(int pstate_index); int get_pstate() const; + /** @deprecated See Host::get_speed() */ XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_speed() instead.") double getSpeed() { return get_speed(); } + /** @deprecated See Host::get_pstate_speed() */ XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_pstate_speed() instead.") double getPstateSpeed(int pstate_index) { return get_pstate_speed(pstate_index); @@ -129,6 +132,7 @@ public: * This is defined in the platform file, and cannot be modified programatically (yet). */ std::unordered_map const& get_mounted_storages(); + /** @deprecated See Host::get_mounted_storages() */ XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_mounted_storages() instead.") std::unordered_map const& getMountedStorages() { return get_mounted_storages(); @@ -147,40 +151,54 @@ public: void execute(double flops, double priority); // Deprecated functions + /** @deprecated See Host::get_name() */ XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_name()") simgrid::xbt::string const& getName() const { return name_; } + /** @deprecated See Host::get_cname() */ XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_cname()") const char* getCname() const { return name_.c_str(); } + /** @deprecated See Host::get_all_actors() */ XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_all_actors()") void actorList(std::vector* whereto); + /** @deprecated See Host::get_all_actors() */ XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_all_actors()") void getProcesses(std::vector* list); + /** @deprecated See Host::turn_on() */ XBT_ATTRIB_DEPRECATED_v323("Please use Host::turn_on()") void turnOn() { turn_on(); } + /** @deprecated See Host::turn_off() */ XBT_ATTRIB_DEPRECATED_v323("Please use Host::turn_off()") void turnOff() { turn_off(); } + /** @deprecated See Host::is_on() */ XBT_ATTRIB_DEPRECATED_v323("Please use Host::is_on()") bool isOn() { return is_on(); } + /** @deprecated See Host::is_off() */ XBT_ATTRIB_DEPRECATED_v323("Please use Host::is_off()") bool isOff() { return is_off(); } - + /** @deprecated See Host::get_property() */ XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_property()") const char* getProperty(const char* key) { return get_property(key); } + /** @deprecated See Host::set_property() */ XBT_ATTRIB_DEPRECATED_v323("Please use Host::set_property()") void setProperty(std::string key, std::string value) { set_property(key, value); } + /** @deprecated See Host::set_pstate() */ XBT_ATTRIB_DEPRECATED_v323("Please use Host::set_pstate()") void setPstate(int idx) { set_pstate(idx); } + /** @deprecated See Host::get_pstate() */ XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_pstate()") int getPstate() { return get_pstate(); } - + /** @deprecated See Host::route_to() */ XBT_ATTRIB_DEPRECATED_v323("Please use Host::route_to()") void routeTo(Host* dest, std::vector& links, double* latency) { route_to(dest, links, latency); } + /** @deprecated See Host::route_to() */ XBT_ATTRIB_DEPRECATED_v323("Please use Host::route_to()") void routeTo( Host* dest, std::vector& links, double* latency) { route_to(dest, links, latency); } + /** @deprecated See Host::get_core_count() */ XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_core_count()") int getCoreCount() { return get_core_count(); } + /** @deprecated See Host::get_pstate_count() */ XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_pstate_count()") int getPstatesCount() const { return get_pstate_count(); diff --git a/include/simgrid/s4u/Link.hpp b/include/simgrid/s4u/Link.hpp index a0b4a5b57f..8cb9612bcb 100644 --- a/include/simgrid/s4u/Link.hpp +++ b/include/simgrid/s4u/Link.hpp @@ -96,26 +96,43 @@ public: on_communication_state_change; // Deprecated methods + /** @deprecated */ XBT_ATTRIB_DEPRECATED_v323("Please use Link::by_name()") static Link* byName(const char* name) { return by_name(name); } + /** @deprecated */ XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_name()") const std::string& getName() const { return get_name(); } + /** @deprecated */ XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_cname()") const char* getCname() const { return get_cname(); } + /** @deprecated */ XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_sharing_policy()") SharingPolicy sharingPolicy() {return get_sharing_policy();} + /** @deprecated */ XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_usage()") double getUsage() {return get_usage();} + /** @deprecated */ XBT_ATTRIB_DEPRECATED_v323("Please use Link::is_used()") bool isUsed() {return is_used();} + /** @deprecated */ XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_bandwidth()") double bandwidth() {return get_bandwidth();} + /** @deprecated */ XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_latency()") double latency() {return get_latency();} + /** @deprecated */ XBT_ATTRIB_DEPRECATED_v323("Please use Link::turn_on()") void turnOn() {turn_on();} + /** @deprecated */ XBT_ATTRIB_DEPRECATED_v323("Please use Link::turn_off()") void turnOff() {turn_off();} + /** @deprecated */ XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_property()") const char* getProperty(const char* key) {return get_property(key);} + /** @deprecated */ XBT_ATTRIB_DEPRECATED_v323("Please use Link::set_property()") void setProperty(std::string key, std::string value) {set_property(key, value);} + /** @deprecated */ XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_data()") void* getData() {return get_data();} + /** @deprecated */ XBT_ATTRIB_DEPRECATED_v323("Please use Link::set_data()") void setData(void* d) {set_data(d);} + /** @deprecated */ XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_state_trace()") void setStateTrace(tmgr_trace_t trace) {set_state_trace(trace);} + /** @deprecated */ XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_bandwidth_trace()") void setBandwidthTrace(tmgr_trace_t trace) {set_bandwidth_trace(trace);} + /** @deprecated */ XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_latency_trace()") void setLatencyTrace(tmgr_trace_t trace) {set_latency_trace(trace);} }; } diff --git a/include/simgrid/s4u/Mailbox.hpp b/include/simgrid/s4u/Mailbox.hpp index acce469a00..8b4267a86f 100644 --- a/include/simgrid/s4u/Mailbox.hpp +++ b/include/simgrid/s4u/Mailbox.hpp @@ -168,24 +168,31 @@ public: void* get(double timeout); // Deprecated functions + /** @deprecated Mailbox::set_receiver() */ XBT_ATTRIB_DEPRECATED_v323("Please use Mailbox::set_receiver()") void setReceiver(ActorPtr actor) { set_receiver(actor); } + /** @deprecated Mailbox::get_receiver() */ XBT_ATTRIB_DEPRECATED_v323("Please use Mailbox::get_receiver()") ActorPtr getReceiver() { return get_receiver(); } + /** @deprecated Mailbox::get_name() */ XBT_ATTRIB_DEPRECATED_v323("Please use Mailbox::get_name()") const simgrid::xbt::string& getName() const { return get_name(); } + /** @deprecated Mailbox::get_cname() */ XBT_ATTRIB_DEPRECATED_v323("Please use Mailbox::get_cname()") const char* getCname() const { return get_cname(); } + /** @deprecated Mailbox::get_impl() */ XBT_ATTRIB_DEPRECATED_v323("Please use Mailbox::get_impl()") kernel::activity::MailboxImpl* getImpl() { return get_impl(); } + /** @deprecated Mailbox::by_name() */ XBT_ATTRIB_DEPRECATED_v323("Please use Mailbox::by_name()") static MailboxPtr byName(const char* name) { return by_name(name); } + /** @deprecated Mailbox::by_name() */ XBT_ATTRIB_DEPRECATED_v323("Please use Mailbox::by_name()") static MailboxPtr byName(std::string name) { return by_name(name); diff --git a/include/simgrid/s4u/Mutex.hpp b/include/simgrid/s4u/Mutex.hpp index b30de03c12..b4df2e8b42 100644 --- a/include/simgrid/s4u/Mutex.hpp +++ b/include/simgrid/s4u/Mutex.hpp @@ -55,6 +55,7 @@ public: bool try_lock(); // deprecated + /** @deprecated Mutex::create() */ XBT_ATTRIB_DEPRECATED_v323("Please use Mutex::create()") static Ptr createMutex() { return create(); } }; diff --git a/include/simgrid/s4u/NetZone.hpp b/include/simgrid/s4u/NetZone.hpp index 1771886264..8156699c38 100644 --- a/include/simgrid/s4u/NetZone.hpp +++ b/include/simgrid/s4u/NetZone.hpp @@ -75,41 +75,54 @@ public: static simgrid::xbt::signal on_seal; // Deprecation wrappers + /** @deprecated NetZone::get_father() */ XBT_ATTRIB_DEPRECATED_v323("Please use NetZone::get_father()") NetZone* getFather() { return get_father(); } + /** @deprecated NetZone::get_name() */ XBT_ATTRIB_DEPRECATED_v323("Please use NetZone::get_name()") const std::string& getName() const { return get_name(); } + /** @deprecated NetZone::get_cname() */ XBT_ATTRIB_DEPRECATED_v323("Please use NetZone::get_cname()") const char* getCname() const { return get_cname(); } + /** @deprecated NetZone::add_route() */ XBT_ATTRIB_DEPRECATED_v323("Please use NetZone::add_route()") void addRoute( kernel::routing::NetPoint* src, kernel::routing::NetPoint* dst, kernel::routing::NetPoint* gw_src, kernel::routing::NetPoint* gw_dst, std::vector& link_list, bool symmetrical) { add_route(src, dst, gw_src, gw_dst, link_list, symmetrical); } + /** @deprecated NetZone::add_bypass_route() */ XBT_ATTRIB_DEPRECATED_v323("Please use NetZone::add_bypass_route()") void addBypassRoute( kernel::routing::NetPoint* src, kernel::routing::NetPoint* dst, kernel::routing::NetPoint* gw_src, kernel::routing::NetPoint* gw_dst, std::vector& link_list, bool symmetrical) { add_bypass_route(src, dst, gw_src, gw_dst, link_list, symmetrical); } + /** @deprecated NetZone::get_properties() */ XBT_ATTRIB_DEPRECATED_v323("Please use NetZone::get_properties()") std::unordered_map* getProperties() { return get_properties(); } + /** @deprecated NetZone::get_property() */ XBT_ATTRIB_DEPRECATED_v323("Please use NetZone::get_property()") const char* getProperty(const char* key) { return get_property(key); } + /** @deprecated NetZone::set_property() */ XBT_ATTRIB_DEPRECATED_v323("Please use NetZone::set_property()") void setProperty(const char* key, const char* value) { set_property(key, value); } + /** @deprecated NetZone::add_component() */ XBT_ATTRIB_DEPRECATED_v323("Please use NetZone::add_component()") int addComponent(kernel::routing::NetPoint* elm) { return add_component(elm); } + /** @deprecated NetZone::get_vertices() */ XBT_ATTRIB_DEPRECATED_v323("Please use NetZone::get_vertices()") std::vector getVertices(); + /** @deprecated NetZone::get_host_count() */ XBT_ATTRIB_DEPRECATED_v323("Please use NetZone::get_host_count()") int getHostCount() { return get_host_count(); } + /** @deprecated NetZone::get_all_hosts() */ XBT_ATTRIB_DEPRECATED_v323("Please use NetZone::get_all_hosts()") void getHosts( std::vector* whereto); // retrieve my content as a vector of hosts + /** @deprecated NetZone::get_children() */ XBT_ATTRIB_DEPRECATED_v323("Please use NetZone::get_children()") std::vector* getChildren() { std::vector* res = new std::vector(); diff --git a/include/simgrid/s4u/Storage.hpp b/include/simgrid/s4u/Storage.hpp index 38931236f8..bd6b092c21 100644 --- a/include/simgrid/s4u/Storage.hpp +++ b/include/simgrid/s4u/Storage.hpp @@ -20,6 +20,7 @@ extern template class XBT_PUBLIC Extendable; } namespace s4u { +/** @deprecated Engine::get_all_storages() */ XBT_ATTRIB_DEPRECATED_v322("Please use Engine::get_all_storages()") XBT_PUBLIC void getStorageList(std::map* whereTo); class XBT_PUBLIC Storage : public simgrid::xbt::Extendable { @@ -65,14 +66,20 @@ public: surf::StorageImpl* get_impl() { return pimpl_; } // Deprecated functions + /** @deprecated Storage::by_name() */ XBT_ATTRIB_DEPRECATED_v323("Please use Storage::by_name()") Storage* byName(std::string name) { return by_name(name); } + /** @deprecated Storage::get_name() */ XBT_ATTRIB_DEPRECATED_v323("Please use Storage::get_name()") std::string const& getName() const { return get_name(); } + /** @deprecated Storage::get_cname() */ XBT_ATTRIB_DEPRECATED_v323("Please use Storage::get_cname()") const char* getCname() const { return get_cname(); } + /** @deprecated Storage::get_type() */ XBT_ATTRIB_DEPRECATED_v323("Please use Storage::get_type()") const char* getType() { return get_type(); } + /** @deprecated Storage::get_host() */ XBT_ATTRIB_DEPRECATED_v323("Please use Storage::get_host()") Host* getHost() { return get_host(); } + /** @deprecated Storage::get_properties() */ XBT_ATTRIB_DEPRECATED_v323("Please use Storage::get_properties()") std::map* getProperties() { std::map* res = new std::map(); @@ -81,15 +88,19 @@ public: res->insert(kv); return res; } + /** @deprecated Storage::get_property() */ XBT_ATTRIB_DEPRECATED_v323("Please use Storage::get_property()") const char* getProperty(const char* key) { return get_property(key); } + /** @deprecated Storage::set_property() */ XBT_ATTRIB_DEPRECATED_v323("Please use Storage::set_property()") void setProperty(std::string key, std::string value) { set_property(key, value); } + /** @deprecated Storage::set_data() */ XBT_ATTRIB_DEPRECATED_v323("Please use Storage::set_data()") void setUserdata(void* data) { set_data(data); } + /** @deprecated Storage::get_data() */ XBT_ATTRIB_DEPRECATED_v323("Please use Storage::get_data()") void* getUserdata() { return get_data(); } private: diff --git a/include/simgrid/s4u/VirtualMachine.hpp b/include/simgrid/s4u/VirtualMachine.hpp index bdbff23b15..69221c8b78 100644 --- a/include/simgrid/s4u/VirtualMachine.hpp +++ b/include/simgrid/s4u/VirtualMachine.hpp @@ -61,21 +61,28 @@ public: static simgrid::xbt::signal 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); } }; } -- 2.20.1