A Discrete-Event Network Simulator
API
Core

The "core" module contains: More...

+ Collaboration diagram for Core:

Modules

 Attributes
 The ns-3 attribute system is the mechanism used in ns-3 to organize, document, and modify the values used by the various component models.
 
 Callbacks
 Wrap functions, objects, and arguments into self contained callbacks.
 
 Command Line Parsing
 A uniform way to specify program documentation, allowed command line arguments and help strings, and set any attribute or global value, all from the command line directly.
 
 Configuration
 Configuration of simulation parameters and tracing.
 
 Debugging tools
 Assertions, breakpoints, logging, and abnormal program termination.
 
 Fatal Error Handlers
 Functions to help clean up when a fatal error is encountered.
 
 Hash Functions
 Generic Hash function interface.
 
 High Precision Q64.64
 Functions and class for high precision Q64.64 fixed point arithmetic.
 
 NonCopyable and Singleton
 Helpers to make classes non-copyable or singleton.
 
 Object
 Base classes which provide memory management and object aggregation.
 
 Random Variables
 ns-3 random numbers are provided via instances of ns3::RandomVariableStream.
 
 Scheduler and Events
 Manage the event list by creating and scheduling events.
 
 Simulator
 Control the virtual time and the execution of simulation events.
 
 Smart Pointer
 Heap memory management.
 
 System Services
 System-independent interfaces to operating system services: files system, threading, wall clock time.
 
 Testing
 Tools to define and execute unit tests.
 
 Tracing
 Publish/subscribe tools to collect and report changes to any values used by the various model components.
 
 Virtual Time
 Management of virtual time in real world units.
 
 Virtual Time Timer and Watchdog
 The Timer and Watchdog objects both facilitate scheduling functions to execute a specified virtual time in the future.
 

Files

file  deprecated.h
 Definition of the NS_DEPRECATED macro.
 
file  global-value.cc
 ns3::GlobalValue implementation.
 
file  global-value.h
 ns3::GlobalValue declaration.
 
file  math.h
 Custom version of log2() to deal with Bug 1467.
 
file  simulation-singleton.h
 ns3::SimulationSingleton declaration and template implementation.
 
file  unused.h
 Definition of the NS_UNUSED NS_UNUSED_GLOBAL macros.
 

Classes

class  ns3::SimulationSingleton< T >
 This singleton class template ensures that the type for which we want a singleton has a lifetime bounded by the simulation run lifetime. More...
 

Macros

#define NS_DEPRECATED
 Mark a function as deprecated. More...
 
#define NS_UNUSED(x)   ((void)(x))
 Mark a local variable as unused. More...
 
#define NS_UNUSED_GLOBAL(x)   x
 Mark a variable at file scope as unused. More...
 

Detailed Description

The "core" module contains:

Macro Definition Documentation

#define NS_DEPRECATED

Mark a function as deprecated.

Users should expect deprecated features to be removed eventually.

When deprecating a feature, please update the documentation with information for users on how to update their code.

For example,

/*
* Do something useful.
*
* \deprecated This method will go away in future versions of ns-3.
* See instead TheNewWay()
*/
void SomethingUseful (void);
/*
* Do something more useful.
*/
void TheNewWay (void);

Definition at line 60 of file deprecated.h.

#define NS_UNUSED_GLOBAL (   x)    x

Mark a variable at file scope as unused.

Definition at line 50 of file unused.h.