Skip to content
Snippets Groups Projects
Commit 3e476849 authored by jgatt's avatar jgatt
Browse files

Better comment user_windows file

parent 78c9bad6
Branches
Tags
1 merge request!12Merge Request multibehavior
Pipeline #5475 passed with warnings
......@@ -10,7 +10,7 @@ DMWindow_list::DMWindow_list(std::vector<DMWindow> window_array){
bool DMWindow_list::date_in_dm_window(double date){
// Return if the date belong in one of the dm_window of the list
/* Returns true if the date is in one of the dm_window of the DMWindow_list */
std::vector<DMWindow_list>::size_type index = index_in_dm_window(date);
return index!=content.size();
}
......
......@@ -23,12 +23,13 @@ struct DMWindow_list
/**
* @brief User class that combines all the demand_response class given in user_replay
* @details this User act as Replay_user_rigid when it is in no window contained
* in the fields 'red_windows', 'yellow_windows', 'dm_window'
* When in these windows it change behavior as detailed in red_window_behavior
* for 'red_windows' and 'dm_windows' that uses randomness.
* And for 'yellow_windows', it is detailed in yellow_window_behavior.
* @brief User class that adopts a different set of submission behaviors depending
* on the energy state (red, yellow, green)
* @details Below are the behaviors drawn at random when the date is in a particular window
* - red window: behaviors degrad, c_you_later, renounce, reconfig and rigid
* - yellow window: behaviors degrad, reconfig and rigid
* - otherwise ("green window"): rigid
* See the documentation of red_window_behavior and yellow_window_behavior.
*/
class DMUserMultiBehavior : public DMUserRenonce,public DMUserReconfig,
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment