User Manual, Developers Guide and API Documentation

wifimac::management::VirtualCapabilityInformationBase Class Reference

Allows "magic" (simulation-only) information exchange about the node's capabilities. More...

#include <management/VirtualCapabilityInformationBase.hpp>

Inheritance diagram for wifimac::management::VirtualCapabilityInformationBase:

Inheritance graph
[legend]
Collaboration diagram for wifimac::management::VirtualCapabilityInformationBase:

Collaboration graph
[legend]

List of all members.

Public Member Functions

virtual void doStartup ()
 Virtual backend of startup().
template<typename T>
get (const wns::service::dll::UnicastAddress adr, const std::string &key) const
InformationBasegetAll (const wns::service::dll::UnicastAddress adr) const
bool knows (const wns::service::dll::UnicastAddress adr) const
bool knows (const wns::service::dll::UnicastAddress adr, const std::string &key) const
virtual void onNodeCreated ()
 Called by the parent node after all components of the parent node have been created.
virtual void onShutdown ()
 Called by the parent node after simulation end event occured.
virtual void onWorldCreated ()
 Called by the parent node after all nodes have been setup and all components have executed onNodeCreated().
template<typename T>
void set (const wns::service::dll::UnicastAddress adr, const std::string &key, const T value)
 VirtualCapabilityInformationBase (wns::node::Interface *_node, const wns::pyconfig::View &_config)
virtual ~VirtualCapabilityInformationBase ()

Private Attributes

InformationBasedefaultValues
 the default values database
wns::logger::Logger logger
 the logger
NodeBasenodeInformationBase
 the database


Detailed Description

The virtual capability information base is a global blackboard accessible by any node in the simulation. It can be used to easily exchange information about capabilities without the (regular) way of exchanging management information requests and replies.

One example of the usage of this information base is the exchange of the number of antennas for MIMO transmissions: To determine the optimal number of streams, the transmitter has to know the number of antennas at the receiver. In reality, this information is exchanged via management frames. If for a particular evaluation this information exchange is not relevant for the simulation results itself, it can be made "magic", i.e. use this information base instead transmitting packets.

Definition at line 66 of file VirtualCapabilityInformationBase.hpp.


Constructor & Destructor Documentation

VirtualCapabilityInformationBase::VirtualCapabilityInformationBase ( wns::node::Interface _node,
const wns::pyconfig::View _config 
)

Definition at line 65 of file VirtualCapabilityInformationBase.cpp.

virtual wifimac::management::VirtualCapabilityInformationBase::~VirtualCapabilityInformationBase (  )  [inline, virtual]

Definition at line 79 of file VirtualCapabilityInformationBase.hpp.


Member Function Documentation

virtual void wifimac::management::VirtualCapabilityInformationBase::doStartup (  )  [inline, virtual]

template<typename T>
T wifimac::management::VirtualCapabilityInformationBase::get ( const wns::service::dll::UnicastAddress  adr,
const std::string &  key 
) const [inline]

Definition at line 105 of file VirtualCapabilityInformationBase.hpp.

InformationBase * VirtualCapabilityInformationBase::getAll ( const wns::service::dll::UnicastAddress  adr  )  const

Definition at line 130 of file VirtualCapabilityInformationBase.cpp.

bool VirtualCapabilityInformationBase::knows ( const wns::service::dll::UnicastAddress  adr  )  const

Definition at line 115 of file VirtualCapabilityInformationBase.cpp.

bool VirtualCapabilityInformationBase::knows ( const wns::service::dll::UnicastAddress  adr,
const std::string &  key 
) const

Definition at line 91 of file VirtualCapabilityInformationBase.cpp.

virtual void wifimac::management::VirtualCapabilityInformationBase::onNodeCreated (  )  [inline, virtual]

Note:
Intra-Node dependencies like connecting components within the node to each other must be handled here. It is forbidden to try to resolve dependencies to other nodes here. Not all nodes have been setup yet.

Implements wns::node::component::Interface.

Definition at line 86 of file VirtualCapabilityInformationBase.hpp.

virtual void wifimac::management::VirtualCapabilityInformationBase::onShutdown (  )  [inline, virtual]

virtual void wifimac::management::VirtualCapabilityInformationBase::onWorldCreated (  )  [inline, virtual]

Note:
Resolve Inter-Node dependencies here. There are no restrictions on what you do here.

Implements wns::node::component::Interface.

Definition at line 90 of file VirtualCapabilityInformationBase.hpp.

template<typename T>
void wifimac::management::VirtualCapabilityInformationBase::set ( const wns::service::dll::UnicastAddress  adr,
const std::string &  key,
const T  value 
) [inline]

Definition at line 133 of file VirtualCapabilityInformationBase.hpp.


Member Data Documentation

Definition at line 166 of file VirtualCapabilityInformationBase.hpp.

Definition at line 156 of file VirtualCapabilityInformationBase.hpp.

Definition at line 161 of file VirtualCapabilityInformationBase.hpp.


The documentation for this class was generated from the following files:

Generated on Sat May 26 03:32:44 2012 for openWNS by  doxygen 1.5.5