equal
deleted
inserted
replaced
228 Model Description |
228 Model Description |
229 ***************** |
229 ***************** |
230 |
230 |
231 The source code for the new module lives in the directory ``src/%(MODULE)s``. |
231 The source code for the new module lives in the directory ``src/%(MODULE)s``. |
232 |
232 |
|
233 Add here a basic description of what is being modeled. |
|
234 |
233 Design |
235 Design |
234 ====== |
236 ====== |
235 |
237 |
236 Add here an overall description of the software design and how it fits |
238 Briefly describe the software design of the model and how it fits into |
237 into the existing ns-3 architecture. |
239 the existing ns-3 architecture. |
238 |
240 |
239 Scope and Limitations |
241 Scope and Limitations |
240 ===================== |
242 ===================== |
241 |
243 |
242 What can the model do? What can it not do? Please use this section to |
244 What can the model do? What can it not do? Please use this section to |
250 |
252 |
251 Usage |
253 Usage |
252 ***** |
254 ***** |
253 |
255 |
254 This section is principally concerned with the usage of your model, using |
256 This section is principally concerned with the usage of your model, using |
255 the public API. |
257 the public API. Focus first on most common usage patterns, then go |
|
258 into more advanced topics. |
256 |
259 |
257 Building New Module |
260 Building New Module |
258 =================== |
261 =================== |
259 |
262 |
260 Include this section if there are special build instructions. |
263 Include this subsection only if there are special build instructions or |
261 |
264 platform limitations. |
262 Helper |
265 |
|
266 Helpers |
|
267 ======= |
|
268 |
|
269 What helper API will users typically use? Describe it here. |
|
270 |
|
271 Attributes |
|
272 ========== |
|
273 |
|
274 What classes hold attributes, and what are the key ones worth mentioning? |
|
275 |
|
276 Output |
263 ====== |
277 ====== |
264 |
278 |
265 What helper API will users typically use? Describe it here. |
279 What kind of data does the model generate? What are the key trace |
|
280 sources? What kind of logging output can be enabled? |
266 |
281 |
267 Advanced Usage |
282 Advanced Usage |
268 ============== |
283 ============== |
269 |
284 |
270 Go into further details (such as using the API outside of the helpers) |
285 Go into further details (such as using the API outside of the helpers) |
272 |
287 |
273 Examples |
288 Examples |
274 ======== |
289 ======== |
275 |
290 |
276 What examples using this new code are available? Describe them here. |
291 What examples using this new code are available? Describe them here. |
|
292 |
|
293 Troubleshooting |
|
294 =============== |
|
295 |
|
296 Add any tips for avoiding pitfalls, etc. |
277 |
297 |
278 Validation |
298 Validation |
279 ********** |
299 ********** |
280 |
300 |
281 Describe how the model has been tested/validated. What tests run in the |
301 Describe how the model has been tested/validated. What tests run in the |