Module Groups

In order to structure the API documentation of the MF we defined several groups. You can view the different groups by clicking on the modules link at the top of the API Reference page.

All main classes should be placed in either of the following groups. To do so please add a @ingroup <groupname> within the detailed description of the class. For more details concerning documentation please refer to the Documentation Guidelines.

All implemented modules are member in one of the following groups, depending on their functionality. Additionally a module may be member of other groups (see description below).

• applLayer -- Application Layer Modules
• netwLayer -- Network Layer Modules
• nic -- network interface modules
• macLayer -- MAC Layer Modules
• radios -- radio modules
• phyLayer -- physical layer modules
• decider -- Decider Modules
• snrEval -- Modules for Attenuation and Interference Calculation
• mobility -- Modules handling the Mobility of the Hosts

All classes of the core MF can be found within the core group. The group structure reflects the directory structure of the core directory.

• core -- modules of the core framework
• basicModules -- basic Module classes
• basicNetworks - basic network modules
• blackboard -- Blackboard related stuff
• channelControl -- handling of connection within the MF
• basicUtils -- utilities for the core MF