eosim::statics::TimeWeighted                 EoSimulator Programmer's Manual

 

NAME

      TimeWeighted: Time Weighted Histogram

 

SYNOPSIS

      #include <eosim/statics/timeweighted.hpp>

 

      namespace eosim {

      namespace statics {

 

class TimeWeighted: public Histogram {

public:

TimeWeighted(double lower_, double upper_,double width_, std::string name_);

void log(double x_);

};

 

      }

      }

 

DESCRIPTION

This kind of histogram shows the values reached by response variables, and the time these values sustain.

 

CLASS OPERATIONS

TimeWeighted(double lower_, double upper_,double width_, std::string name_):

      The constructor of TimeWeighted. To create a TimeWeighted histogram the programmer have to specify the relevant interval of values [lower_, upper_]. width_ indicates the length of the subintervals in which [lower_, upper_] is divided (lower_ to upper_ by width_). If lower_ is greater or equal than upper_ or width_ is negative, the simulation aborts immediately displaying an error message.

     

void log(double x_):

            This operations register x_, the y value registered is the time interval between invocations. If the histogram hasn’t been registered to a model, the simulation aborts immediately displaying an error message.

 

 

SEE ALSO

eosim::statics::Histogram