1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
|
/* Copyright (c) 2012 Massachusetts Institute of Technology
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
#ifndef __DSENT_MODEL_OPTICALGRAPH_OPTICALNODE_H__
#define __DSENT_MODEL_OPTICALGRAPH_OPTICALNODE_H__
#include "model/OpticalModel.h"
#include "util/CommonType.h"
namespace DSENT
{
class OpticalNode;
//TODO: Change to detector
typedef std::pair<OpticalNode*, double> DetectorEntry;
typedef std::vector<DetectorEntry> DetectorTable;
class OpticalNode
{
public:
// The starting visited number flag of all optical nodes
static const int OPTICAL_NODE_INIT_VISITED_NUM;
// The types of optical nodes that can exist
enum Type
{
WAVEGUIDE,
LASER,
MODULATOR,
FILTER,
DETECTOR
};
public:
OpticalNode(Type type_, const String& instance_name_, OpticalModel* model_, const WavelengthGroup& wavelengths_);
~OpticalNode();
public:
// Get the type of optical node
Type getType() const;
// Return instance name
const String& getInstanceName() const;
// Get the downstream optical nodes
vector<OpticalNode*>* getDownstreamNodes() const;
// Connect the downstream optical node
void addDownstreamNode(OpticalNode* node_);
// Return the node's parent model
OpticalModel* getModel();
const OpticalModel* getModel() const;
// Get wavelength groups
WavelengthGroup getWavelengths() const;
// Returns whether the node is expecting a set of wavelengths
bool isExpected(const WavelengthGroup& wavelengths_) const;
// Trace wavelengths, find and put all found lasers, modulators, and detectors
//virtual void traceWavelengths(const WavelengthGroup& wavelengths_, OpticalNode* laser_,
// OpticalNode* modulator_, DetectorTable* detectors_, double current_loss_) const;
//-----------------------------------------------------------------
// Node variables for wavelength tracing
//-----------------------------------------------------------------
// Loss incurred at this optical node
void setLoss(double loss_);
double getLoss() const;
// Visited number marker
void setVisitedNum(int visited_num_);
int getVisitedNum() const;
//-----------------------------------------------------------------
private:
// Disable copy constructor
OpticalNode(const OpticalNode& node_);
private:
// The type of optical node
const Type m_type_;
// Name of this instance
String m_instance_name_;
// A pointer to the model that contains this node
OpticalModel* m_model_;
// Downstream optical node
vector<OpticalNode*>* m_downstream_nodes_;
// Path visited count (so that you don't have to clear it)
int m_visited_num_;
// The amount of loss incurred at this optical node
double m_loss_;
// The wavelengths this optical node is supposed to see
const WavelengthGroup m_wavelengths_;
};
} // namespace DSENT
#endif // __DSENT_MODEL_OPTICALGRAPH_OPTICALNODE_H__
|
