-//using namespace generic;
+/* Copyright (c) 2004-2016. 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. */
#ifndef SURF_MODEL_H_
#define SURF_MODEL_H_
#include <xbt.h>
#include <string>
#include <vector>
-#include <iostream>
#include <memory>
+#include <utility>
+
#include <boost/function.hpp>
#include <boost/intrusive/list.hpp>
#include "surf/trace_mgr.h"
#include "surf/surf_routing.h"
#include "simgrid/platf_interface.h"
#include "surf/surf.h"
-#include "surf/surf_private.h"
-#include "internal_config.h"
+#include "src/surf/surf_private.h"
+#include "src/internal_config.h"
-#define LIBSIGC ok
#ifdef LIBSIGC
#include <sigc++/sigc++.h>
-#define surf_callback(arg1, ...) sigc::signal<arg1,__VA_ARGS__>
-#define surf_callback_connect(callback, fun_ptr) callback.connect(sigc::ptr_fun(fun_ptr))
-#define surf_callback_emit(callback, ...) callback.emit(__VA_ARGS__)
+namespace simgrid {
+namespace surf {
+ // Wraps sigc++ signals with the interface of boost::signals2:
+ template<class T> class signal;
+ template<class R, class... P>
+ class signal<R(P...)> {
+ private:
+ sigc::signal<R, P...> sig_;
+ public:
+ template<class U> XBT_ALWAYS_INLINE
+ void connect(U&& slot)
+ {
+ sig_.connect(std::forward<U>(slot));
+ }
+ template<class Res, class... Args> XBT_ALWAYS_INLINE
+ void connect(Res(*slot)(Args...))
+ {
+ sig_.connect(sigc::ptr_fun(slot));
+ }
+ template<class... Args>
+ R operator()(Args&&... args) const
+ {
+ return sig_.emit(std::forward<Args>(args)...);
+ }
+ };
+}
+}
#else
#include <boost/signals2.hpp>
-#define surf_callback(arg1, ...) boost::signals2::signal<arg1(__VA_ARGS__)>
-#define surf_callback_connect(callback, fun_ptr) callback.connect(fun_ptr)
-#define surf_callback_emit(callback, ...) callback(__VA_ARGS__)
+namespace simgrid {
+namespace surf {
+ template<class T>
+ using signal = ::boost::signals2::signal<T>;
+}
+}
#endif
-extern tmgr_history_t history;
+extern XBT_PRIVATE tmgr_history_t history;
#define NO_MAX_DURATION -1.0
-using namespace std;
-
-/** \ingroup SURF_simulation
- * \brief Return the current time
- *
- * Return the current time in millisecond.
- */
-
/*********
* Utils *
*********/
/* user-visible parameters */
-extern double sg_tcp_gamma;
-extern double sg_sender_gap;
-extern double sg_latency_factor;
-extern double sg_bandwidth_factor;
-extern double sg_weight_S_parameter;
-extern int sg_network_crosstraffic;
-#ifdef HAVE_GTNETS
-extern double sg_gtnets_jitter;
-extern int sg_gtnets_jitter_seed;
-#endif
-extern xbt_dynar_t surf_path;
+extern XBT_PRIVATE double sg_tcp_gamma;
+extern XBT_PRIVATE double sg_sender_gap;
+extern XBT_PRIVATE double sg_latency_factor;
+extern XBT_PRIVATE double sg_bandwidth_factor;
+extern XBT_PRIVATE double sg_weight_S_parameter;
+extern XBT_PRIVATE int sg_network_crosstraffic;
+extern XBT_PRIVATE xbt_dynar_t surf_path;
extern "C" {
XBT_PUBLIC(double) surf_get_clock(void);
}
-extern double sg_sender_gap;
-XBT_PUBLIC(int) SURF_CPU_LEVEL; //Surf cpu level
+extern XBT_PRIVATE double sg_sender_gap;
+
+namespace simgrid {
+namespace surf {
-int __surf_is_absolute_file_path(const char *file_path);
+extern XBT_PRIVATE simgrid::surf::signal<void(void)> surfExitCallbacks;
+
+}
+}
+
+int XBT_PRIVATE __surf_is_absolute_file_path(const char *file_path);
/***********
* Classes *
***********/
-//class Model;
-typedef Model* ModelPtr;
-
-//class Resource;
-typedef Resource* ResourcePtr;
-typedef boost::function<void (ResourcePtr r)> ResourceCallback;
-
-//class Action;
-typedef Action* ActionPtr;
-typedef boost::function<void (ActionPtr a)> ActionCallback;
-
-typedef boost::intrusive::list<Action> ActionList;
-typedef ActionList* ActionListPtr;
-typedef boost::intrusive::list_base_hook<> actionHook;
-
-struct lmmTag;
-typedef boost::intrusive::list<Action, boost::intrusive::base_hook<boost::intrusive::list_base_hook<boost::intrusive::tag<lmmTag> > > > ActionLmmList;
-typedef ActionLmmList* ActionLmmListPtr;
-typedef boost::intrusive::list_base_hook<boost::intrusive::tag<lmmTag> > actionLmmHook;
-
enum heap_action_type{
LATENCY = 100,
XBT_PUBLIC_DATA(xbt_dict_t) traces_set_list;
XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_host_avail;
XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_power;
-XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_link_avail;
-XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_bandwidth;
+XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_link_avail;
+XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_bandwidth;
XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_latency;
-/*********
- * Model *
- *********/
-XBT_PUBLIC_DATA(xbt_dynar_t) model_list;
-
-class Model {
- const char *p_name;
+/**********
+ * Action *
+ **********/
- ActionListPtr p_readyActionSet; /**< Actions in state SURF_ACTION_READY */
- ActionListPtr p_runningActionSet; /**< Actions in state SURF_ACTION_RUNNING */
- ActionListPtr p_failedActionSet; /**< Actions in state SURF_ACTION_FAILED */
- ActionListPtr p_doneActionSet; /**< Actions in state SURF_ACTION_DONE */
+XBT_PRIVATE void surf_action_lmm_update_index_heap(void *action, int i);
- ResourceCallback m_resOnCB, m_resOffCB;
- ActionCallback m_actCancelCB, m_actSuspendCB, m_actResumeCB;
+XBT_PUBLIC_DATA(xbt_dynar_t) all_existing_models;
-protected:
- ActionLmmListPtr p_modifiedSet;
+namespace simgrid {
+namespace surf {
- lmm_system_t p_maxminSystem;
- e_UM_t p_updateMechanism;
- int m_selectiveUpdate;
- xbt_heap_t p_actionHeap;
+/** @ingroup SURF_interface
+ * @brief SURF action interface class
+ * @details An action is an event generated by a resource (e.g.: a communication for the network)
+ */
+XBT_PUBLIC_CLASS Action {
+public:
+ boost::intrusive::list_member_hook<> action_hook;
+ boost::intrusive::list_member_hook<> action_lmm_hook;
+ typedef boost::intrusive::member_hook<
+ Action, boost::intrusive::list_member_hook<>, &Action::action_hook> ActionOptions;
+ typedef boost::intrusive::list<Action, ActionOptions> ActionList;
+private:
+ /**
+ * @brief Common initializations for the constructors
+ */
+ void initialize(simgrid::surf::Model *model, double cost, bool failed,
+ lmm_variable_t var = NULL);
public:
- Model(const char *name);
- virtual ~Model();
+ /**
+ * @brief Action constructor
+ *
+ * @param model The Model associated to this Action
+ * @param cost The cost of the Action
+ * @param failed If the action is impossible (e.g.: execute something on a switched off host)
+ */
+ Action(simgrid::surf::Model *model, double cost, bool failed);
+
+ /**
+ * @brief Action constructor
+ *
+ * @param model The Model associated to this Action
+ * @param cost The cost of the Action
+ * @param failed If the action is impossible (e.g.: execute something on a switched off host)
+ * @param var The lmm variable associated to this Action if it is part of a LMM component
+ */
+ Action(simgrid::surf::Model *model, double cost, bool failed, lmm_variable_t var);
+
+ /** @brief Destructor */
+ virtual ~Action();
- const char *getName() {return p_name;}
- virtual ActionListPtr getReadyActionSet() {return p_readyActionSet;}
- virtual ActionListPtr getRunningActionSet() {return p_runningActionSet;}
- virtual ActionListPtr getFailedActionSet() {return p_failedActionSet;}
- virtual ActionListPtr getDoneActionSet() {return p_doneActionSet;}
- virtual ActionLmmListPtr getModifiedSet() {return p_modifiedSet;}
- lmm_system_t getMaxminSystem() {return p_maxminSystem;}
- e_UM_t getUpdateMechanism() {return p_updateMechanism;}
- xbt_heap_t getActionHeap() {return p_actionHeap;}
+ /** @brief Mark that the action is now finished */
+ void finish();
- ActionPtr createAction(double _cost, bool _failed);
- virtual double shareResources(double now);
- virtual double shareResourcesLazy(double now);
- virtual double shareResourcesFull(double now);
- double shareResourcesMaxMin(ActionListPtr running_actions,
- lmm_system_t sys,
- void (*solve) (lmm_system_t));
- virtual void updateActionsState(double now, double delta);
- virtual void updateActionsStateLazy(double now, double delta);
- virtual void updateActionsStateFull(double now, double delta);
+ /** @brief Get the [state](\ref e_surf_action_state_t) of the current Action */
+ e_surf_action_state_t getState(); /**< get the state*/
+ /** @brief Set the [state](\ref e_surf_action_state_t) of the current Action */
+ virtual void setState(e_surf_action_state_t state);
- void addTurnedOnCallback(ResourceCallback rc);
- void notifyResourceTurnedOn(ResourcePtr r);
+ /** @brief Get the bound of the current Action */
+ double getBound();
+ /** @brief Set the bound of the current Action */
+ void setBound(double bound);
- void addTurnedOffCallback(ResourceCallback rc);
- void notifyResourceTurnedOff(ResourcePtr r);
+ /** @brief Get the start time of the current action */
+ double getStartTime();
+ /** @brief Get the finish time of the current action */
+ double getFinishTime();
- void addActionCancelCallback(ActionCallback ac);
- void notifyActionCancel(ActionPtr a);
- void addActionResumeCallback(ActionCallback ac);
- void notifyActionResume(ActionPtr a);
- void addActionSuspendCallback(ActionCallback ac);
- void notifyActionSuspend(ActionPtr a);
-};
+ /** @brief Get the user data associated to the current action */
+ void *getData() {return p_data;}
+ /** @brief Set the user data associated to the current action */
+ void setData(void* data);
-/************
- * Resource *
- ************/
+ /** @brief Get the cost of the current action */
+ double getCost() {return m_cost;}
+ /** @brief Set the cost of the current action */
+ void setCost(double cost) {m_cost = cost;}
-/**
- * Resource which have a metric handled by a maxmin system
- */
-typedef struct {
- double scale;
- double peak;
- tmgr_trace_event_t event;
-} s_surf_metric_t;
+ /** @brief Update the maximum duration of the current action
+ * @param delta Amount to remove from the MaxDuration */
+ void updateMaxDuration(double delta) {double_update(&m_maxDuration, delta,sg_surf_precision);}
-class Resource {
- void *p_resource;
- const char *p_name;
- ModelPtr p_model;
- xbt_dict_t p_properties;
- bool m_running;
+ /** @brief Update the remaining time of the current action
+ * @param delta Amount to remove from the remaining time */
+ void updateRemains(double delta) {double_update(&m_remains, delta, sg_maxmin_precision*sg_surf_precision);}
-protected:
- e_surf_resource_state_t m_stateCurrent;
+ /** @brief Set the remaining time of the current action */
+ void setRemains(double value) {m_remains = value;}
+ /** @brief Get the remaining time of the current action after updating the resource */
+ virtual double getRemains();
+ /** @brief Get the remaining time of the current action without updating the resource */
+ double getRemainsNoUpdate();
-public:
- Resource();
- Resource(ModelPtr model, const char *name, xbt_dict_t props);
- Resource(ModelPtr model, const char *name, xbt_dict_t props, lmm_constraint_t constraint);
- Resource(ModelPtr model, const char *name, xbt_dict_t props, e_surf_resource_state_t stateInit);
- Resource(ModelPtr model, const char *name, xbt_dict_t props, e_surf_resource_state_t stateInit, lmm_constraint_t constraint);
-
- virtual ~Resource() {
- xbt_free((void*)p_name);
- xbt_dict_free(&p_properties);
- };
+ /** @brief Set the finish time of the current action */
+ void setFinishTime(double value) {m_finish = value;}
- ModelPtr getModel() {return p_model;};
- const char *getName() {return p_name;};
- virtual xbt_dict_t getProperties() {return p_properties;};
+ /**@brief Add a reference to the current action (refcounting) */
+ void ref();
+ /** @brief Unref that action (and destroy it if refcount reaches 0)
+ * @return true if the action was destroyed and false if someone still has references on it
+ */
+ virtual int unref();
- virtual void updateState(tmgr_trace_event_t event_type, double value, double date)=0;
- virtual bool isUsed()=0;
- bool isOn();
- void turnOn();
- void turnOff();
- void setName(string name);
+ /** @brief Cancel the current Action if running */
+ virtual void cancel();
- virtual e_surf_resource_state_t getState();
- virtual void setState(e_surf_resource_state_t state);
+ /** @brief Suspend the current Action */
+ virtual void suspend();
- /* LMM */
-private:
- lmm_constraint_t p_constraint;
-public:
- lmm_constraint_t getConstraint() {return p_constraint;};
+ /** @brief Resume the current Action */
+ virtual void resume();
-};
+ /** @brief Returns true if the current action is running */
+ virtual bool isSuspended();
-/**********
- * Action *
- **********/
-void surf_action_lmm_update_index_heap(void *action, int i);
+ /** @brief Get the maximum duration of the current action */
+ double getMaxDuration() {return m_maxDuration;}
+ /** @brief Set the maximum duration of the current Action */
+ virtual void setMaxDuration(double duration);
-class Action : public actionHook, public actionLmmHook {
- ActionLmmListPtr p_modifiedSet;
- xbt_heap_t p_actionHeap;
- int m_selectiveUpdate;
- ModelPtr p_model;
- double m_bound; /**< the capping of the CPU use */
- bool m_failed;
+ /** @brief Get the tracing category associated to the current action */
+ char *getCategory() {return p_category;}
+ /** @brief Set the tracing category of the current Action */
+ void setCategory(const char *category);
+
+ /** @brief Get the priority of the current Action */
+ double getPriority() {return m_priority;};
+ /** @brief Set the priority of the current Action */
+ virtual void setPriority(double priority);
+
+ /** @brief Get the state set in which the action is */
+ ActionList* getStateSet() {return p_stateSet;};
+
+ s_xbt_swag_hookup_t p_stateHookup = {NULL,NULL};
+
+ simgrid::surf::Model *getModel() {return p_model;}
+
+protected:
+ ActionList* p_stateSet;
+ double m_priority = 1.0; /**< priority (1.0 by default) */
+ int m_refcount = 1;
+ double m_remains; /**< How much of that cost remains to be done in the currently running task */
+ double m_maxDuration = NO_MAX_DURATION; /*< max_duration (may fluctuate until the task is completed) */
+ double m_finish = -1; /**< finish time : this is modified during the run and fluctuates until the task is completed */
+
+private:
double m_start; /**< start time */
- char *p_category; /**< tracing category for categorized resource utilization monitoring */
+ char *p_category = NULL; /**< tracing category for categorized resource utilization monitoring */
#ifdef HAVE_LATENCY_BOUND_TRACKING
int m_latencyLimited; /**< Set to 1 if is limited by latency, 0 otherwise */
#endif
- int m_cost;
- void *p_data; /**< for your convenience */
+ double m_cost;
+ simgrid::surf::Model *p_model;
+ void *p_data = NULL; /**< for your convenience */
+
+ /* LMM */
+public:
+ virtual void updateRemainingLazy(double now);
+ void heapInsert(xbt_heap_t heap, double key, enum heap_action_type hat);
+ void heapRemove(xbt_heap_t heap);
+ void heapUpdate(xbt_heap_t heap, double key, enum heap_action_type hat);
+ void updateIndexHeap(int i);
+ lmm_variable_t getVariable() {return p_variable;}
+ double getLastUpdate() {return m_lastUpdate;}
+ void refreshLastUpdate() {m_lastUpdate = surf_get_clock();}
+ enum heap_action_type getHat() {return m_hat;}
+ bool is_linked() {return action_lmm_hook.is_linked();}
+ void gapRemove();
protected:
- ActionListPtr p_stateSet;
- double m_priority; /**< priority (1.0 by default) */
- int m_refcount;
- double m_remains; /**< How much of that cost remains to be done in the currently running task */
- double m_maxDuration; /*< max_duration (may fluctuate until the task is completed) */
- double m_finish; /**< finish time : this is modified during the run and fluctuates until the task is completed */
+ lmm_variable_t p_variable;
+ double m_lastValue = 0;
+ double m_lastUpdate = 0;
+ int m_suspended = 0;
+ int m_indexHeap;
+ enum heap_action_type m_hat = NOTSET;
+};
- ModelPtr getModel() {return p_model;}
+typedef Action::ActionList ActionList;
+typedef boost::intrusive::member_hook<
+ Action, boost::intrusive::list_member_hook<>, &Action::action_lmm_hook> ActionLmmOptions;
+typedef boost::intrusive::list<Action, ActionLmmOptions> ActionLmmList;
+typedef ActionLmmList* ActionLmmListPtr;
+
+/*********
+ * Model *
+ *********/
+
+/** @ingroup SURF_interface
+ * @brief SURF model interface class
+ * @details A model is an object which handle the interactions between its Resources and its Actions
+ */
+XBT_PUBLIC_CLASS Model {
public:
+ Model();
+ virtual ~Model();
- Action();
- Action(ModelPtr model, double cost, bool failed);
- Action(ModelPtr model, double cost, bool failed, lmm_variable_t var);
- virtual ~Action();
-
- void finish();
- s_xbt_swag_hookup_t p_stateHookup;
+ virtual void addTraces() =0;
- e_surf_action_state_t getState(); /**< get the state*/
- virtual void setState(e_surf_action_state_t state); /**< Change state*/
- double getBound() {return m_bound;}
- double getStartTime(); /**< Return the start time of an action */
- double getFinishTime(); /**< Return the finish time of an action */
- void *getData() {return p_data;}
- void setData(void* data);
- double getMaxDuration() {return m_maxDuration;}
- char *getCategory() {return p_category;}
- double getCost() {return m_cost;}
- void setCost(double cost) {m_cost = cost;}
+ /** @brief Get the set of [actions](@ref Action) in *ready* state */
+ virtual ActionList* getReadyActionSet() {return p_readyActionSet;}
- void updateMaxDuration(double delta) {double_update(&m_maxDuration, delta);}
- void updateRemains(double delta) {double_update(&m_remains, delta);}
- void setRemains(double value) {m_remains = value;}
- void setFinishTime(double value) {m_finish = value;}
+ /** @brief Get the set of [actions](@ref Action) in *running* state */
+ virtual ActionList* getRunningActionSet() {return p_runningActionSet;}
+ /** @brief Get the set of [actions](@ref Action) in *failed* state */
+ virtual ActionList* getFailedActionSet() {return p_failedActionSet;}
- void ref();
- virtual int unref(); /**< Specify that we don't use that action anymore. Returns true if the action was destroyed and false if someone still has references on it. */
- virtual void cancel(); /**< Cancel a running action */
- virtual void recycle(){}; /**< Recycle an action */
-
- virtual void suspend(); /**< Suspend an action */
- virtual void resume(); /**< Resume a suspended action */
- virtual bool isSuspended(); /**< Return whether an action is suspended */
- virtual void setMaxDuration(double duration); /**< Set the max duration of an action*/
- virtual void setPriority(double priority); /**< Set the priority of an action */
-#ifdef HAVE_TRACING
- void setCategory(const char *category); /**< Set the category of an action */
-#endif
- virtual double getRemains(); /**< Get the remains of an action */
- double getRemainsNoUpdate();
+ /** @brief Get the set of [actions](@ref Action) in *done* state */
+ virtual ActionList* getDoneActionSet() {return p_doneActionSet;}
-#ifdef HAVE_LATENCY_BOUND_TRACKING
- int getLatencyLimited(); /**< Return 1 if action is limited by latency, 0 otherwise */
-#endif
+ /** @brief Get the set of modified [actions](@ref Action) */
+ virtual ActionLmmListPtr getModifiedSet() {return p_modifiedSet;}
- double getPriority() {return m_priority;};
- ActionListPtr getStateSet() {return p_stateSet;};
+ /** @brief Get the maxmin system of the current Model */
+ lmm_system_t getMaxminSystem() {return p_maxminSystem;}
-private:
- int resourceUsed(void *resource_id);
- /* Share the resources to the actions and return in how much time
- the next action may terminate */
- double shareResources(double now);
- /* Update the actions' state */
- void updateActionsState(double now, double delta);
- void updateResourceState(void *id, tmgr_trace_event_t event_type,
- double value, double time);
+ /**
+ * @brief Get the update mechanism of the current Model
+ * @see e_UM_t
+ */
+ e_UM_t getUpdateMechanism() {return p_updateMechanism;}
+
+ /** @brief Get Action heap */
+ xbt_heap_t getActionHeap() {return p_actionHeap;}
+
+ /**
+ * @brief Share the resources between the actions
+ *
+ * @param now The current time of the simulation
+ * @return The delta of time till the next action will finish
+ */
+ virtual double shareResources(double now);
+ virtual double shareResourcesLazy(double now);
+ virtual double shareResourcesFull(double now);
+ double shareResourcesMaxMin(ActionList* running_actions,
+ lmm_system_t sys,
+ void (*solve) (lmm_system_t));
+
+ /**
+ * @brief Update action to the current time
+ *
+ * @param now The current time of the simulation
+ * @param delta The delta of time since the last update
+ */
+ virtual void updateActionsState(double now, double delta);
+ virtual void updateActionsStateLazy(double now, double delta);
+ virtual void updateActionsStateFull(double now, double delta);
+
+ /** @brief Returns whether this model have an idempotent shareResource()
+ *
+ * The only model that is not is NS3: computing the next timestamp moves the model up to that point,
+ * so we need to call it only when the next timestamp of other sources is computed.
+ */
+ virtual bool shareResourcesIsIdempotent()=0;
- /* LMM */
protected:
- lmm_variable_t p_variable;
- double m_lastUpdate;
- double m_lastValue;
- int m_suspended;
- int m_indexHeap;
- enum heap_action_type m_hat;
+ ActionLmmListPtr p_modifiedSet;
+ lmm_system_t p_maxminSystem = nullptr;
+ e_UM_t p_updateMechanism = UM_UNDEFINED;
+ int m_selectiveUpdate;
+ xbt_heap_t p_actionHeap;
+
+private:
+ ActionList* p_readyActionSet; /**< Actions in state SURF_ACTION_READY */
+ ActionList* p_runningActionSet; /**< Actions in state SURF_ACTION_RUNNING */
+ ActionList* p_failedActionSet; /**< Actions in state SURF_ACTION_FAILED */
+ ActionList* p_doneActionSet; /**< Actions in state SURF_ACTION_DONE */
+};
+
+}
+}
+
+/************
+ * Resource *
+ ************/
+
+/** @ingroup SURF_interface
+ * @brief Resource which have a metric handled by a maxmin system
+ */
+typedef struct {
+ double peak; /**< The peak of the metric, ie its max value */
+ double scale; /**< Current availability of the metric according to the traces, in [0,1] */
+ tmgr_trace_event_t event; /**< The associated trace event associated to the metric */
+} s_surf_metric_t;
+
+namespace simgrid {
+namespace surf {
+/** @ingroup SURF_interface
+ * @brief SURF resource interface class
+ * @details A resource represent an element of a component (e.g.: a link for the network)
+ */
+XBT_PUBLIC_CLASS Resource {
public:
- virtual void updateRemainingLazy(double now);
- void heapInsert(xbt_heap_t heap, double key, enum heap_action_type hat);
- void heapRemove(xbt_heap_t heap);
- void updateIndexHeap(int i);
- lmm_variable_t getVariable() {return p_variable;}
- double getLastUpdate() {return m_lastUpdate;}
- void refreshLastUpdate() {m_lastUpdate = surf_get_clock();}
- enum heap_action_type getHat() {return m_hat;}
- bool is_linked() {return actionLmmHook::is_linked();}
- void gapRemove();
+ /**
+ * @brief Constructor of non-LMM Resources
+ *
+ * @param model Model associated to this Resource
+ * @param name The name of the Resource
+ */
+ Resource(Model *model, const char *name);
+
+ /**
+ * @brief Constructor of LMM Resources
+ *
+ * @param model Model associated to this Resource
+ * @param name The name of the Resource
+ * @param constraint The lmm constraint associated to this Resource if it is part of a LMM component
+ */
+ Resource(Model *model, const char *name, lmm_constraint_t constraint);
+
+ Resource(Model *model, const char *name, lmm_constraint_t constraint, int initiallyOn);
+
+ /**
+ * @brief Resource constructor
+ *
+ * @param model Model associated to this Resource
+ * @param name The name of the Resource
+ * @param initiallyOn the initial state of the Resource
+ */
+ Resource(Model *model, const char *name, int initiallyOn);
+
+ virtual ~Resource();
+
+ /** @brief Get the Model of the current Resource */
+ Model *getModel();
+
+ /** @brief Get the name of the current Resource */
+ const char *getName();
+
+ /**
+ * @brief Update the state of the current Resource
+ * @details [TODO]
+ *
+ * @param event_type [TODO]
+ * @param value [TODO]
+ * @param date [TODO]
+ */
+ virtual void updateState(tmgr_trace_event_t event_type, double value, double date)=0;
+
+ /** @brief Check if the current Resource is used (if it currently serves an action) */
+ virtual bool isUsed()=0;
+
+ /** @brief Check if the current Resource is active */
+ virtual bool isOn();
+ /** @brief Check if the current Resource is shut down */
+ virtual bool isOff();
+ /** @brief Turn on the current Resource */
+ virtual void turnOn();
+ /** @brief Turn off the current Resource */
+ virtual void turnOff();
+
+private:
+ const char *p_name;
+ Model *p_model;
+ bool m_isOn;
+
+public: /* LMM */
+ /** @brief Get the lmm constraint associated to this Resource if it is part of a LMM component */
+ lmm_constraint_t getConstraint();
+protected:
+ lmm_constraint_t p_constraint = nullptr;
};
+}
+}
+
#endif /* SURF_MODEL_H_ */
