C++ API - frepple::utils::TimeLine< type >::EventMaxQuantity Class Reference

Public Member Functions | Protected Attributes | Friends | List of all members
frepple::utils::TimeLine< type >::EventMaxQuantity Class Reference

A timeline event representing a change of the maximum target. More...

#include <timeline.h>

Inheritance diagram for frepple::utils::TimeLine< type >::EventMaxQuantity:
Inheritance graph
[legend]

Public Member Functions

 EventMaxQuantity (Date d, double f=0.0)
 
virtual double getMax (bool inclusive=true) const
 
virtual unsigned short getType () const
 
void setMax (double f)
 
- Public Member Functions inherited from frepple::utils::TimeLine< type >::Event
double getCumulativeConsumed () const
 
double getCumulativeProduced () const
 
const Date & getDate () const
 
virtual double getMin (bool inclusive=true) const
 
double getOnhand () const
 
virtual double getQuantity () const
 
virtual TimeLine< type > * getTimeLine () const
 
bool operator< (const Event &fl2) const
 
virtual ~Event ()
 

Protected Attributes

EventMaxQuantity * prevMax
 
- Protected Attributes inherited from frepple::utils::TimeLine< type >::Event
double cum_prod
 
Date dt
 
Event * next
 
double oh
 
Event * prev
 

Friends

class Event
 
class TimeLine< type >
 

Additional Inherited Members

- Protected Member Functions inherited from frepple::utils::TimeLine< type >::Event
 Event ()
 

Detailed Description

template<class type>
class frepple::utils::TimeLine< type >::EventMaxQuantity

A timeline event representing a change of the maximum target.

Definition at line 168 of file timeline.h.

Constructor & Destructor Documentation

template<class type>
frepple::utils::TimeLine< type >::EventMaxQuantity::EventMaxQuantity ( Date  d,
double  f = 0.0 
)
inline

Definition at line 177 of file timeline.h.

Member Function Documentation

template<class type>
virtual double frepple::utils::TimeLine< type >::EventMaxQuantity::getMax ( bool  inclusive = true) const
inlinevirtual

This functions returns the maximum boundary valid at the time of this event.

Reimplemented from frepple::utils::TimeLine< type >::Event.

Definition at line 180 of file timeline.h.

template<class type>
virtual unsigned short frepple::utils::TimeLine< type >::EventMaxQuantity::getType ( ) const
inlinevirtual

Implements frepple::utils::TimeLine< type >::Event.

Definition at line 185 of file timeline.h.

template<class type>
void frepple::utils::TimeLine< type >::EventMaxQuantity::setMax ( double  f)
inline

Definition at line 179 of file timeline.h.

Friends And Related Function Documentation

template<class type>
friend class Event
friend

Definition at line 170 of file timeline.h.

template<class type>
friend class TimeLine< type >
friend

Definition at line 171 of file timeline.h.

Member Data Documentation

template<class type>
EventMaxQuantity* frepple::utils::TimeLine< type >::EventMaxQuantity::prevMax
protected

Definition at line 175 of file timeline.h.

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