SimGrid  3.14.159
Versatile Simulation of Distributed Systems
simgrid::surf::NetworkNS3Action Class Reference

#include <network_ns3.hpp>

Inheritance diagram for simgrid::surf::NetworkNS3Action:
simgrid::surf::NetworkAction simgrid::surf::Action

Public Member Functions

 NetworkNS3Action (Model *model, double cost, s4u::Host *src, s4u::Host *dst)
 
bool isSuspended ()
 Returns true if the current action is running. More...
 
int unref ()
 Unref that action (and destroy it if refcount reaches 0) More...
 
void suspend ()
 Suspend the current Action. More...
 
void resume ()
 Resume the current Action. More...
 
- Public Member Functions inherited from simgrid::surf::NetworkAction
 NetworkAction (simgrid::surf::Model *model, double cost, bool failed)
 Constructor. More...
 
 NetworkAction (simgrid::surf::Model *model, double cost, bool failed, lmm_variable_t var)
 NetworkAction constructor. More...
 
void setState (simgrid::surf::Action::State state) override
 Set the state of the current Action. More...
 
- Public Member Functions inherited from simgrid::surf::Action
 Action (simgrid::surf::Model *model, double cost, bool failed)
 Action constructor. More...
 
 Action (simgrid::surf::Model *model, double cost, bool failed, lmm_variable_t var)
 Action constructor. More...
 
virtual ~Action ()
 Destructor. More...
 
void finish ()
 Mark that the action is now finished. More...
 
Action::State getState ()
 Get the state of the current Action. More...
 
double getBound ()
 Get the bound of the current Action. More...
 
void setBound (double bound)
 Set the bound of the current Action. More...
 
double getStartTime ()
 Get the start time of the current action. More...
 
double getFinishTime ()
 Get the finish time of the current action. More...
 
voidgetData ()
 Get the user data associated to the current action. More...
 
void setData (void *data)
 Set the user data associated to the current action. More...
 
double getCost ()
 Get the cost of the current action. More...
 
void setCost (double cost)
 Set the cost of the current action. More...
 
void updateMaxDuration (double delta)
 Update the maximum duration of the current action. More...
 
void updateRemains (double delta)
 Update the remaining time of the current action. More...
 
void setRemains (double value)
 Set the remaining time of the current action. More...
 
virtual double getRemains ()
 Get the remaining time of the current action after updating the resource. More...
 
double getRemainsNoUpdate ()
 Get the remaining time of the current action without updating the resource. More...
 
void setFinishTime (double value)
 Set the finish time of the current action. More...
 
void ref ()
 Add a reference to the current action (refcounting) More...
 
virtual void cancel ()
 Cancel the current Action if running. More...
 
double getMaxDuration ()
 Get the maximum duration of the current action. More...
 
virtual void setMaxDuration (double duration)
 Set the maximum duration of the current Action. More...
 
char * getCategory ()
 Get the tracing category associated to the current action. More...
 
void setCategory (const char *category)
 Set the tracing category of the current Action. More...
 
double getPriority ()
 Get the priority of the current Action. More...
 
virtual void setPriority (double priority)
 Set the priority of the current Action. More...
 
ActionListgetStateSet ()
 Get the state set in which the action is. More...
 
simgrid::surf::ModelgetModel ()
 
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 ()
 
double getLastUpdate ()
 
void refreshLastUpdate ()
 
enum heap_action_type getHat ()
 
bool is_linked ()
 
void gapRemove ()
 

Public Attributes

double lastSent_ = 0
 
s4u::Hostsrc_
 
s4u::Hostdst_
 
- Public Attributes inherited from simgrid::surf::NetworkAction
double latency_
 
double latCurrent_
 
double weight_
 
double rate_
 
const char * senderLinkName_
 
double senderSize_
 
xbt_fifo_item_t senderFifoItem_
 
- Public Attributes inherited from simgrid::surf::Action
boost::intrusive::list_member_hook action_hook
 
boost::intrusive::list_member_hook action_lmm_hook
 
s_xbt_swag_hookup_t stateHookup_ = {nullptr,nullptr}
 

Additional Inherited Members

- Public Types inherited from simgrid::surf::Action
enum  State {
  State::ready = 0, State::running, State::failed, State::done,
  State::to_free, State::not_in_the_system
}
 
typedef boost::intrusive::member_hook< Action, boost::intrusive::list_member_hook<>, &Action::action_hookActionOptions
 
typedef boost::intrusive::list< Action, ActionOptionsActionList
 
- Protected Attributes inherited from simgrid::surf::Action
ActionListstateSet_
 
double priority_ = 1.0
 priority (1.0 by default) More...
 
int refcount_ = 1
 
double remains_
 How much of that cost remains to be done in the currently running task. More...
 
double maxDuration_ = NO_MAX_DURATION
 
double finishTime_ = -1
 finish time : this is modified during the run and fluctuates until the task is completed More...
 
lmm_variable_t variable_ = nullptr
 
double lastValue_ = 0
 
double lastUpdate_ = 0
 
int suspended_ = 0
 
int indexHeap_
 
enum heap_action_type hat_ = NOTSET
 

Constructor & Destructor Documentation

§ NetworkNS3Action()

simgrid::surf::NetworkNS3Action::NetworkNS3Action ( Model model,
double  cost,
s4u::Host src,
s4u::Host dst 
)

Member Function Documentation

§ isSuspended()

bool simgrid::surf::NetworkNS3Action::isSuspended ( )
virtual

Returns true if the current action is running.

Reimplemented from simgrid::surf::Action.

§ unref()

int simgrid::surf::NetworkNS3Action::unref ( )
virtual

Unref that action (and destroy it if refcount reaches 0)

Returns
true if the action was destroyed and false if someone still has references on it

Reimplemented from simgrid::surf::Action.

§ suspend()

void simgrid::surf::NetworkNS3Action::suspend ( )
virtual

Suspend the current Action.

Reimplemented from simgrid::surf::Action.

§ resume()

void simgrid::surf::NetworkNS3Action::resume ( )
virtual

Resume the current Action.

Reimplemented from simgrid::surf::Action.

Member Data Documentation

§ lastSent_

double simgrid::surf::NetworkNS3Action::lastSent_ = 0

§ src_

s4u::Host* simgrid::surf::NetworkNS3Action::src_

§ dst_

s4u::Host* simgrid::surf::NetworkNS3Action::dst_

The documentation for this class was generated from the following files: