OpticalTransmitter.h revision 10448 
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_OPTICALGRAPH_OPTICALTRANSMITTER_H__
23#define __DSENT_MODEL_OPTICALGRAPH_OPTICALTRANSMITTER_H__
24
25#include "model/OpticalModel.h"
26#include "util/CommonType.h"
27
28namespace DSENT
29{
30    // The job of a optical sender interface is to provide a function to
31    // allow the insertion loss and extinction ratio to be changed
32    class OpticalTransmitter
33    {
34        public:
35            OpticalTransmitter(){};
36            virtual ~OpticalTransmitter(){};
37
38        public:
39            // Set the transmitter specifications, returns whether it is possible
40            // to build a modulator that met those specs
41            virtual bool setTransmitterSpec(double IL_dB_, double ER_dB_) = 0;
42            // Returns power of the transmitter at a given utilization
43            virtual double getPower(double util_) const = 0;
44    }; // class OpticalTransmitter
45
46} // namespace DSENT
47
48#endif // __DSENT_MODEL_OPTICALGRAPH_OPTICALTRANSMITTER_H__
49
50