SimGrid: surf_model Struct Reference

SimGrid 3.10 Versatile Simulation of Distributed Systems

- Home page
- Online documentation
- Dev's Corner

All Data Structures Functions Variables Typedefs Enumerations Enumerator Groups Pages
Data Fields
surf_model Struct Reference

Model datatype. More...

`#include <surf.h>`

## Data Fields
const char * | name
s_surf_action_state_t | states
e_surf_action_state_t(* | action_state_get )(surf_action_t action)
void(* | action_state_set )(surf_action_t action, e_surf_action_state_t state)
double(* | action_get_start_time )(surf_action_t action)
double(* | action_get_finish_time )(surf_action_t action)
int(* | action_unref )(surf_action_t action)
void(* | action_cancel )(surf_action_t action)
void(* | action_recycle )(surf_action_t action)
void(* | action_data_set )(surf_action_t action, void *data)
void(* | suspend )(surf_action_t action)
void(* | resume )(surf_action_t action)
int(* | is_suspended )(surf_action_t action)
void(* | set_max_duration )(surf_action_t action, double duration)
void(* | set_priority )(surf_action_t action, double priority)
void(* | set_category )(surf_action_t action, const char *category)
double(* | get_remains )(surf_action_t action)

## Detailed Description

Model datatype.

Generic data structure for a model. The workstations, the CPUs and the network links are examples of models.

## Field Documentation

const char* surf_model::name

Name of this model

s_surf_action_state_t surf_model::states

Any living action on this model

e_surf_action_state_t(* surf_model::action_state_get)(surf_action_t action)

Return the state of an action

void(* surf_model::action_state_set)(surf_action_t action, e_surf_action_state_t state)

Change an action state

double(* surf_model::action_get_start_time)(surf_action_t action)

Return the start time of an action

double(* surf_model::action_get_finish_time)(surf_action_t action)

Return the finish time of an action

int(* surf_model::action_unref)(surf_action_t action)

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.

void(* surf_model::action_cancel)(surf_action_t action)

Cancel a running action

void(* surf_model::action_recycle)(surf_action_t action)

Recycle an action

void(* surf_model::action_data_set)(surf_action_t action, void *data)

Set the user data of an action

void(* surf_model::suspend)(surf_action_t action)

Suspend an action

void(* surf_model::resume)(surf_action_t action)

Resume a suspended action

int(* surf_model::is_suspended)(surf_action_t action)

Return whether an action is suspended

void(* surf_model::set_max_duration)(surf_action_t action, double duration)

Set the max duration of an action

void(* surf_model::set_priority)(surf_action_t action, double priority)

Set the priority of an action

void(* surf_model::set_category)(surf_action_t action, const char *category)

Set the category of an action

double(* surf_model::get_remains)(surf_action_t action)

Get the remains of an action

The documentation for this struct was generated from the following file:

- src/include/surf/surf.h