SUMO - Simulation of Urban MObility
Distribution.h
Go to the documentation of this file.
1 /****************************************************************************/
7 // The base class for distribution descriptions.
8 /****************************************************************************/
9 // SUMO, Simulation of Urban MObility; see http://sumo.dlr.de/
10 // Copyright (C) 2001-2017 DLR (http://www.dlr.de/) and contributors
11 /****************************************************************************/
12 //
13 // This file is part of SUMO.
14 // SUMO is free software: you can redistribute it and/or modify
15 // it under the terms of the GNU General Public License as published by
16 // the Free Software Foundation, either version 3 of the License, or
17 // (at your option) any later version.
18 //
19 /****************************************************************************/
20 #ifndef Distribution_h
21 #define Distribution_h
22 
23 
24 // ===========================================================================
25 // included modules
26 // ===========================================================================
27 #ifdef _MSC_VER
28 #include <windows_config.h>
29 #else
30 #include <config.h>
31 #endif
32 
33 #include <utils/common/Named.h>
34 
35 
36 // ===========================================================================
37 // class declarations
38 // ===========================================================================
39 class MTRand;
40 
41 
42 // ===========================================================================
43 // class definitions
44 // ===========================================================================
50 class Distribution : public Named {
51 public:
53  Distribution(const std::string& id) : Named(id) { }
54 
56  virtual ~Distribution() { }
57 
65  virtual double sample(MTRand* which = 0) const = 0;
66 
68  virtual double getMax() const = 0;
69 
71  virtual std::string toStr(std::streamsize accuracy) const = 0;
72 
73 };
74 
75 
76 #endif
77 
78 /****************************************************************************/
79 
virtual double getMax() const =0
Returns the maximum value of this distribution.
virtual std::string toStr(std::streamsize accuracy) const =0
Returns the string representation of this distribution.
virtual double sample(MTRand *which=0) const =0
Draw a sample of the distribution.
Distribution(const std::string &id)
Constructor.
Definition: Distribution.h:53
Base class for objects which have an id.
Definition: Named.h:46
virtual ~Distribution()
Destructor.
Definition: Distribution.h:56