ns-3 Manual

This is the ns-3 Manual. Primary documentation for the ns-3 project is available in five forms:

• ns-3 Doxygen: Documentation of the public APIs of the simulator
• Tutorial, Manual (this document), and Model Library for the latest release and development tree
• ns-3 wiki

Contents

• Organization
• Random Variables
  • Quick Overview
  • Background
  • Creating random variables
  • Seeding and independent replications
  • Class RandomVariableStream
  • Base class public API
  • Types of RandomVariables
  • Semantics of RandomVariableStream objects
  • Using other PRNG
  • Setting the stream number
  • Publishing your results
  • Summary
• Hash Functions
  • Basic Usage
  • Incremental Hashing
  • Using an Alternative Hash Function
  • Adding New Hash Function Implementations
  • Sources for Hash Functions
• Events and Simulator
  • Event
  • Simulator
  • Time
  • Scheduler
• Callbacks
  • Callbacks Motivation
  • Callbacks Background
  • Using the Callback API
  • Bound Callbacks
  • Traced Callbacks
  • Callback locations in ns-3
  • Implementation details
• Object model
  • Object-oriented behavior
  • Object base classes
  • Memory management and class Ptr
  • CreateObject and Create
  • Aggregation
  • Examples
  • Object factories
  • Downcasting
• Configuration and Attributes
  • Object Overview
  • Attributes
  • Implementation Details
  • ConfigStore
• Object names
• Logging
  • Overview
  • How to add logging to your code
• Tracing
  • Tracing Motivation
  • Overview
  • Using the Tracing API
  • Using Trace Helpers
  • Tracing implementation details
• Data Collection
  • Design
  • Data Collection Helpers
  • Probes
  • Collectors
  • Aggregators
  • Adaptors
  • Scope/Limitations
• Statistical Framework
  • Goals
  • Overview
  • To-Do
  • Approach
  • Example
• RealTime
  • Behavior
  • Usage
  • Implementation
• Helpers
• Making Plots using the Gnuplot Class
  • Creating Plots Using the Gnuplot Class
  • An Example Program that Uses the Gnuplot Class
  • An Example 2-Dimensional Plot
  • An Example 2-Dimensional Plot with Error Bars
  • An Example 3-Dimensional Plot
• Using Python to Run ns-3
  • Introduction
  • An Example Python Script that Runs ns-3
  • Running Python Scripts
  • Caveats
  • Working with Python Bindings
  • Instructions for Handling New Files or Changed API’s
  • More Information for Developers
• Tests
  • Overview
  • Background
  • Testing framework
  • How to write tests
• Support
  • Creating a new ns-3 model
  • Adding a New Module to ns-3
  • Creating Documentation
  • Enabling Subsets of ns-3 Modules
  • Enabling/disabling ns-3 Tests and Examples
  • Troubleshooting

Source

This document is written in reStructuredText for Sphinx and is maintained in the doc/manual directory of ns-3’s source code.