Files
unison/doc/modules

59 lines
2.4 KiB
Plaintext
Raw Normal View History

2008-01-10 07:31:40 -08:00
/**
* @anchor modules_anchor
*
2011-05-10 11:09:17 -07:00
* @defgroup core Core
* \brief The "core" module contains:
2008-01-10 07:31:40 -08:00
* - a time management class to hold a time and convert between various time units: ns3::Time
* - a scheduler base class used to implement new simulation event schedulers:
* ns3::Scheduler and ns3::SchedulerFactory
* - a simulator class used to create, schedule and cancel events: ns3::Simulator
* - a Functor class: ns3::Callback
* - an os-independent interface to get access to the elapsed wall clock time: ns3::SystemWallClockMs
* - a class to register regression tests with the test manager: ns3::Test and ns3::TestManager
* - debugging facilities: \ref logging, \ref assert
2008-01-10 07:31:40 -08:00
* - \ref randomvariable
2008-04-14 16:18:50 -07:00
* - a base class for objects which need to support per-instance "attributes" and
* trace sources: ns3::ObjectBase
2008-01-10 07:31:40 -08:00
* - a base class for objects which need to support reference counting
2008-04-14 16:18:50 -07:00
* and dynamic object aggregation: ns3::Object
2008-01-10 07:31:40 -08:00
* - a smart-pointer class ns3::Ptr designed to work together with ns3::Object
2008-04-14 16:18:50 -07:00
* - a configuration class used to set and control all attributes and trace sources
* in a simulation: ns3::Config.
2008-01-10 07:31:40 -08:00
*
2011-05-10 11:09:17 -07:00
* @defgroup network Network
* The "network" module contains:
2008-01-10 07:31:40 -08:00
* - a packet class to create and manipulate simulation packets:
* ns3::Packet, ns3::Header, and ns3::Trailer. This packet class
* also supports per-packet ns3::Tag which are globs of data
* which can be attached to any packet.
* - a ns3::Node base class which should be subclassed by any new type of
* network Node.
* - models which abstract the MAC-layer from the IP layer protocols:
* ns3::NetDevice and ns3::Channel.
* - models which abstract the application-layer API: ns3::Application,
* ns3::Socket, ns3::SocketFactory, and, ns3::Udp
*
* @defgroup devices Devices
*
2011-05-10 11:09:17 -07:00
* @defgroup internet Internet
2008-01-10 07:31:40 -08:00
*
2011-05-10 11:09:17 -07:00
* The "internet" module contains:
* - an Ipv4 stack
* - an Ipv6 stack
2008-01-10 07:31:40 -08:00
* - an ARP module
* - a UDP and a TCP implementation
2008-01-10 07:31:40 -08:00
*
2009-07-08 10:05:39 -07:00
* @defgroup routing Routing
*
2008-01-10 07:31:40 -08:00
* @defgroup applications Applications
*
* @defgroup mobility Mobility
*
2008-01-10 07:31:40 -08:00
* @defgroup constants Constants
* @brief Constants you can change
*
2010-02-02 22:14:52 -08:00
* @defgroup utils Utils
* @brief The utils directory is for various programs and scripts related
* to code coverage, test suites, style checking, and benchmarking.
2008-05-30 10:36:02 -07:00
*/