1/* Copyright (c) 2012 Massachusetts Institute of Technology
2 *
3 * Permission is hereby granted, free of charge, to any person obtaining a copy
4 * of this software and associated documentation files (the "Software"), to deal
5 * in the Software without restriction, including without limitation the rights
6 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
7 * copies of the Software, and to permit persons to whom the Software is
8 * furnished to do so, subject to the following conditions:
9 *
10 * The above copyright notice and this permission notice shall be included in
11 * all copies or substantial portions of the Software.
12 *
13 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
19 * THE SOFTWARE.
20 */
21
22#ifndef __DSENT_MODEL_OPTICAL_THROTTLEDLASERSOURCE_H__
23#define __DSENT_MODEL_OPTICAL_THROTTLEDLASERSOURCE_H__
24
25#include "util/CommonType.h"
26#include "model/OpticalModel.h"
27
28namespace DSENT
29{
30    class OpticalWavelength;
31
32    // A laser source that outputs some number of wavelengths. This laser
33    // full on/off power gating, thus all power are event-based energies
34    class ThrottledLaserSource : public OpticalModel
35    {
36        public:
37            ThrottledLaserSource(const String& instance_name_, const TechModel* tech_model_);
38            virtual ~ThrottledLaserSource();
39
40        public:
41            // Set a list of properties' name needed to construct model
42            void initParameters();
43            // Set a list of properties' name needed to construct model
44            void initProperties();
45
46        protected:
47            // Build the model
48            void constructModel();
49            void updateModel();
50            void evaluateModel();
51            void useModel();
52
53        private:
54            // Data structure containing the wavelengths that this laser outputs
55            OpticalWavelength* m_wavelength_;
56
57    }; // class ThrottledLaserSource
58} // namespace DSENT
59
60#endif // __DSENT_MODEL_OPTICAL_THROTTLEDLASERSOURCE_H__
61
62