OpticalDetector.h (10447:a465576671d4) OpticalDetector.h (10448:bc1a3b7ab5ef)
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
1#ifndef __DSENT_MODEL_OPTICALGRAPH_OPTICALDETECTOR_H__
2#define __DSENT_MODEL_OPTICALGRAPH_OPTICALDETECTOR_H__
3
4#include "model/optical_graph/OpticalNode.h"
5#include "util/CommonType.h"
6
7namespace DSENT
8{
9 class OpticalReceiver;
10
11 class OpticalDetector : public OpticalNode
12 {
13 public:
14 OpticalDetector(const String& instance_name_, OpticalModel* model_, const WavelengthGroup& wavelengths_, OpticalReceiver* receiver_);
15 ~OpticalDetector();
16
17 public:
18 // Set the responsitivity of the photodetector
19 void setResponsivity(double responsivity_);
20
21 // Get the detector sensitivity given an extinction ratio (in Watts)
22 double getSensitivity(double ER_dB_) const;
23
24 // Ask the receiver for its power (ONLY use for power optimization, as this
25 // assumes an activity of 1.0)
26 double getPower() const;
27
28 private:
29 // Disable copy constructor
30 OpticalDetector(const OpticalDetector& node_);
31
32 private:
33 // The required laser power
34 double m_sensitivity_;
35 // The receiver connected to this detector
36 OpticalReceiver* m_receiver_;
37 // Responsivity of the photodetector
38 double m_responsivity_;
39
40 };
41
42} // namespace DSENT
43
44#endif // __DSENT_MODEL_OPTICALGRAPH_OPTICALDETECTOR_H__
45
22#ifndef __DSENT_MODEL_OPTICALGRAPH_OPTICALDETECTOR_H__
23#define __DSENT_MODEL_OPTICALGRAPH_OPTICALDETECTOR_H__
24
25#include "model/optical_graph/OpticalNode.h"
26#include "util/CommonType.h"
27
28namespace DSENT
29{
30 class OpticalReceiver;
31
32 class OpticalDetector : public OpticalNode
33 {
34 public:
35 OpticalDetector(const String& instance_name_, OpticalModel* model_, const WavelengthGroup& wavelengths_, OpticalReceiver* receiver_);
36 ~OpticalDetector();
37
38 public:
39 // Set the responsitivity of the photodetector
40 void setResponsivity(double responsivity_);
41
42 // Get the detector sensitivity given an extinction ratio (in Watts)
43 double getSensitivity(double ER_dB_) const;
44
45 // Ask the receiver for its power (ONLY use for power optimization, as this
46 // assumes an activity of 1.0)
47 double getPower() const;
48
49 private:
50 // Disable copy constructor
51 OpticalDetector(const OpticalDetector& node_);
52
53 private:
54 // The required laser power
55 double m_sensitivity_;
56 // The receiver connected to this detector
57 OpticalReceiver* m_receiver_;
58 // Responsivity of the photodetector
59 double m_responsivity_;
60
61 };
62
63} // namespace DSENT
64
65#endif // __DSENT_MODEL_OPTICALGRAPH_OPTICALDETECTOR_H__
66