README moves to markdown
[nepi.git] / nepi / resources / ns3 / classes / point_to_point_net_device.py
1 #
2 #    NEPI, a framework to manage network experiments
3 #    Copyright (C) 2014 INRIA
4 #
5 #    This program is free software: you can redistribute it and/or modify
6 #    it under the terms of the GNU General Public License version 2 as
7 #    published by the Free Software Foundation;
8 #
9 #    This program is distributed in the hope that it will be useful,
10 #    but WITHOUT ANY WARRANTY; without even the implied warranty of
11 #    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 #    GNU General Public License for more details.
13 #
14 #    You should have received a copy of the GNU General Public License
15 #    along with this program.  If not, see <http://www.gnu.org/licenses/>.
16 #
17
18 from nepi.execution.attribute import Attribute, Flags, Types
19 from nepi.execution.trace import Trace, TraceAttr
20 from nepi.execution.resource import ResourceManager, clsinit_copy, \
21         ResourceState
22 from nepi.resources.ns3.ns3netdevice import NS3BaseNetDevice 
23
24 @clsinit_copy
25 class NS3PointToPointNetDevice(NS3BaseNetDevice):
26     _rtype = "ns3::PointToPointNetDevice"
27
28     @classmethod
29     def _register_attributes(cls):
30         
31         attr_mtu = Attribute("Mtu",
32             "The MAC-level Maximum Transmission Unit",
33             type = Types.Integer,
34             default = "1500",  
35             allowed = None,
36             range = None,    
37             flags = Flags.Reserved | Flags.Construct)
38
39         cls._register_attribute(attr_mtu)
40
41         attr_address = Attribute("Address",
42             "The MAC address of this device.",
43             type = Types.String,
44             default = "ff:ff:ff:ff:ff:ff",  
45             allowed = None,
46             range = None,    
47             flags = Flags.Reserved | Flags.Construct)
48
49         cls._register_attribute(attr_address)
50
51         attr_datarate = Attribute("DataRate",
52             "The default data rate for point to point links",
53             type = Types.String,
54             default = "32768bps",  
55             allowed = None,
56             range = None,    
57             flags = Flags.Reserved | Flags.Construct)
58
59         cls._register_attribute(attr_datarate)
60
61         attr_interframegap = Attribute("InterframeGap",
62             "The time to wait between packet (frame) transmissions",
63             type = Types.String,
64             default = "+0.0ns",  
65             allowed = None,
66             range = None,    
67             flags = Flags.Reserved | Flags.Construct)
68
69         cls._register_attribute(attr_interframegap)
70
71
72
73     @classmethod
74     def _register_traces(cls):
75         
76         mactx = Trace("MacTx", "Trace source indicating a packet has arrived for transmission by this device")
77
78         cls._register_trace(mactx)
79
80         mactxdrop = Trace("MacTxDrop", "Trace source indicating a packet has been dropped by the device before transmission")
81
82         cls._register_trace(mactxdrop)
83
84         macpromiscrx = Trace("MacPromiscRx", "A packet has been received by this device, has been passed up from the physical layer and is being forwarded up the local protocol stack.  This is a promiscuous trace,")
85
86         cls._register_trace(macpromiscrx)
87
88         macrx = Trace("MacRx", "A packet has been received by this device, has been passed up from the physical layer and is being forwarded up the local protocol stack.  This is a non-promiscuous trace,")
89
90         cls._register_trace(macrx)
91
92         phytxbegin = Trace("PhyTxBegin", "Trace source indicating a packet has begun transmitting over the channel")
93
94         cls._register_trace(phytxbegin)
95
96         phytxend = Trace("PhyTxEnd", "Trace source indicating a packet has been completely transmitted over the channel")
97
98         cls._register_trace(phytxend)
99
100         phytxdrop = Trace("PhyTxDrop", "Trace source indicating a packet has been dropped by the device during transmission")
101
102         cls._register_trace(phytxdrop)
103
104         phyrxend = Trace("PhyRxEnd", "Trace source indicating a packet has been completely received by the device")
105
106         cls._register_trace(phyrxend)
107
108         phyrxdrop = Trace("PhyRxDrop", "Trace source indicating a packet has been dropped by the device during reception")
109
110         cls._register_trace(phyrxdrop)
111
112         sniffer = Trace("Sniffer", "Trace source simulating a non-promiscuous packet sniffer attached to the device")
113
114         cls._register_trace(sniffer)
115
116         promiscsniffer = Trace("PromiscSniffer", "Trace source simulating a promiscuous packet sniffer attached to the device")
117
118         cls._register_trace(promiscsniffer)
119
120
121
122     def __init__(self, ec, guid):
123         super(NS3PointToPointNetDevice, self).__init__(ec, guid)
124         self._home = "ns3-point-to-point-net-device-%s" % self.guid