X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/38f7ddbf61f574a934f191ef2d8358d9f8be1f96..d5c5c81b80995b117219aa475399de9aaeef5763:/include/simgrid/s4u/Activity.hpp diff --git a/include/simgrid/s4u/Activity.hpp b/include/simgrid/s4u/Activity.hpp index 57ab0371c0..b91347cb16 100644 --- a/include/simgrid/s4u/Activity.hpp +++ b/include/simgrid/s4u/Activity.hpp @@ -1,4 +1,4 @@ -/* Copyright (c) 2006-2017. The SimGrid Team. All rights reserved. */ +/* Copyright (c) 2006-2018. 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,65 +6,85 @@ #ifndef SIMGRID_S4U_ACTIVITY_HPP #define SIMGRID_S4U_ACTIVITY_HPP -#include #include -typedef enum { inited = 0, started, canceled, errored, finished } e_s4u_activity_state_t; - namespace simgrid { namespace s4u { /** @brief Activities * - * This class is the ancestor of every activities that an actor can undertake, that is, of the actions that do take time in the simulated world. + * This class is the ancestor of every activities that an actor can undertake. + * That is, of the actions that do take time in the simulated world. */ -XBT_PUBLIC_CLASS Activity { +class XBT_PUBLIC Activity { friend Comm; - friend void intrusive_ptr_release(Comm * c); - friend void intrusive_ptr_add_ref(Comm * c); + friend XBT_PUBLIC void intrusive_ptr_release(Comm * c); + friend XBT_PUBLIC void intrusive_ptr_add_ref(Comm * c); + friend Exec; + friend XBT_PUBLIC void intrusive_ptr_release(Exec * e); + friend XBT_PUBLIC void intrusive_ptr_add_ref(Exec * e); protected: Activity() = default; - ~Activity() = default; + virtual ~Activity() = default; public: Activity(Activity const&) = delete; Activity& operator=(Activity const&) = delete; + enum class State { inited = 0, started, canceled, errored, finished }; + /** Starts a previously created activity. * * This function is optional: you can call wait() even if you didn't call start() */ - virtual void start()=0; + virtual Activity* start() = 0; /** Tests whether the given activity is terminated yet. This is a pure function. */ //virtual bool test()=0; /** Blocks until the activity is terminated */ - virtual void wait()=0; + virtual Activity* wait() = 0; /** Blocks until the activity is terminated, or until the timeout is elapsed * Raises: timeout exception.*/ - virtual void wait(double timeout)=0; + virtual Activity* wait(double timeout) = 0; /** Cancel that activity */ //virtual void cancel(); /** Retrieve the current state of the activity */ - e_s4u_activity_state_t getState() {return state_;} + Activity::State get_state() { return state_; } /** Get the remaining amount of work that this Activity entails. When it's 0, it's done. */ - double getRemains(); + virtual double get_remaining(); + /** Set the [remaining] amount of work that this Activity will entail * * It is forbidden to change the amount of work once the Activity is started */ - void setRemains(double remains); + Activity* set_remaining(double remains); /** Put some user data onto the Activity */ - void setUserData(void *data) {userData_=data;} + Activity* set_user_data(void* data) + { + user_data_ = data; + return this; + } /** Retrieve the user data of the Activity */ - void *getUserData() { return userData_; } + void* get_user_data() { return user_data_; } + + XBT_ATTRIB_DEPRECATED_v323("Please use Activity::get_state()") Activity::State getState() { return state_; } + XBT_ATTRIB_DEPRECATED_v323("Please use Activity::get_remaining()") double getRemains() { return get_remaining(); } + XBT_ATTRIB_DEPRECATED_v323("Please use Activity::set_remaining()") Activity* setRemains(double remains) + { + return set_remaining(remains); + } + XBT_ATTRIB_DEPRECATED_v323("Please use Activity::set_user_data()") Activity* setUserData(void* data) + { + return set_user_data(data); + } + XBT_ATTRIB_DEPRECATED_v323("Please use Activity::get_user_data()") void* getUserData() { return user_data_; } private: simgrid::kernel::activity::ActivityImplPtr pimpl_ = nullptr; - e_s4u_activity_state_t state_ = inited; + Activity::State state_ = Activity::State::inited; double remains_ = 0; - void *userData_ = nullptr; + void* user_data_ = nullptr; }; // class }}; // Namespace simgrid::s4u