User Manual, Developers Guide and API Documentation

wns::ldk::tools::FakeFU Class Reference

In case you need an FU for testing without FUN. More...

#include <ldk/tools/FakeFU.hpp>

Inheritance diagram for wns::ldk::tools::FakeFU:

Inheritance graph
[legend]
Collaboration diagram for wns::ldk::tools::FakeFU:

Collaboration graph
[legend]

List of all members.

Public Member Functions

virtual wns::ldk::CommandactivateCommand (wns::ldk::CommandPool *) const
virtual void calculateSizes (const wns::ldk::CommandPool *, Bit &, Bit &) const
 Calculate the sizes of the PDU.
virtual void commitSizes (wns::ldk::CommandPool *) const
virtual wns::ldk::CommandcopyCommand (const wns::ldk::Command *) const
virtual wns::ldk::CommandcreateCommand () const
virtual wns::ldk::CommandPoolcreateReply (const wns::ldk::CommandPool *) const
 Create a reply to the given CommandPool.
virtual bool doIsAccepting (const CompoundPtr &compound) const
virtual void doOnData (const CompoundPtr &compound)
virtual void doSendData (const CompoundPtr &compound)
virtual void doWakeup ()
 FakeFU ()
virtual wns::ldk::CommandgetCommand (const wns::ldk::CommandPool *) const
virtual size_t getCommandObjSize () const
virtual CommandReaderInterfacegetCommandReader (CommandProxy *)
virtual
wns::ldk::CopyCommandInterface
getCopyCommandInterface () const
virtual fun::FUNgetFUN () const
virtual bool isAcceptingForwarded (const CompoundPtr &compound) const
virtual void onDataForwarded (const CompoundPtr &compound)
virtual void sendDataForwarded (const CompoundPtr &compound)
virtual void wakeupForwarded ()
virtual ~FakeFU ()

Private Attributes

fun::Mainfun


Detailed Description

Author:
Marc Schinnenburg <msg@comnets.rwth-aachen.de>
This FU is intentionally not registered at the StaticFactory

Definition at line 46 of file FakeFU.hpp.


Constructor & Destructor Documentation

wns::ldk::tools::FakeFU::FakeFU (  )  [inline]

Definition at line 54 of file FakeFU.hpp.

virtual wns::ldk::tools::FakeFU::~FakeFU (  )  [inline, virtual]

Definition at line 64 of file FakeFU.hpp.


Member Function Documentation

virtual wns::ldk::Command* wns::ldk::tools::FakeFU::activateCommand ( wns::ldk::CommandPool  )  const [inline, virtual]

Implements wns::ldk::CommandTypeSpecifierInterface.

Definition at line 130 of file FakeFU.hpp.

virtual void wns::ldk::tools::FakeFU::calculateSizes ( const wns::ldk::CommandPool commandPool,
Bit commandPoolSize,
Bit dataSize 
) const [inline, virtual]

During size calculation, each FunctionalUnit is asked for the size of the PCI and SDU. Calculation begins with the layer the PDU last visited. To be able to calculate the sizes, a FunctionalUnit may in turn need to know the sizes as calculated by the FunctionalUnit right above itself.

It can do that by simply asking the CommandProxy, giving itself as questioner. The CommandProxy will then delegate the calculation request to the next higher FunctionalUnit in the path of the PDU.

Implements wns::ldk::CommandTypeSpecifierInterface.

Definition at line 142 of file FakeFU.hpp.

virtual void wns::ldk::tools::FakeFU::commitSizes ( wns::ldk::CommandPool  )  const [inline, virtual]

Implements wns::ldk::CommandTypeSpecifierInterface.

Definition at line 148 of file FakeFU.hpp.

virtual wns::ldk::Command* wns::ldk::tools::FakeFU::copyCommand ( const wns::ldk::Command  )  const [inline, virtual]

Implements wns::ldk::CommandTypeSpecifierInterface.

Definition at line 160 of file FakeFU.hpp.

virtual wns::ldk::Command* wns::ldk::tools::FakeFU::createCommand (  )  const [inline, virtual]

Implements wns::ldk::CommandTypeSpecifierInterface.

Definition at line 154 of file FakeFU.hpp.

virtual wns::ldk::CommandPool* wns::ldk::tools::FakeFU::createReply ( const wns::ldk::CommandPool original  )  const [inline, virtual]

A lower layer asks us to create a reply to the given CommandPool. Some functional units (such as ARQ) need to inject compounds (ACKs) back into the stack as reply to compounds they received.

Unfortunately, not every layer has enough information to create a PCI that codes a valid reply to the original PCI. But it may ask the CommandProxy to construct a reply for it. The CommandProxy in turn delegates the reply creation to the functional units right above the questioner. This is what the default implementation of createReply does, as implemented by CommandTypeSpecifier<>.

Layers that do know, how to create a reply can simply create a CommandPool, activate their Command and fill in the fields to form the reply.

Implements wns::ldk::CommandTypeSpecifierInterface.

Definition at line 136 of file FakeFU.hpp.

virtual bool wns::ldk::tools::FakeFU::doIsAccepting ( const CompoundPtr compound  )  const [inline, virtual]

Definition at line 70 of file FakeFU.hpp.

virtual void wns::ldk::tools::FakeFU::doOnData ( const CompoundPtr compound  )  [inline, virtual]

Definition at line 106 of file FakeFU.hpp.

virtual void wns::ldk::tools::FakeFU::doSendData ( const CompoundPtr compound  )  [inline, virtual]

Definition at line 82 of file FakeFU.hpp.

virtual void wns::ldk::tools::FakeFU::doWakeup (  )  [inline, virtual]

Definition at line 94 of file FakeFU.hpp.

virtual wns::ldk::Command* wns::ldk::tools::FakeFU::getCommand ( const wns::ldk::CommandPool  )  const [inline, virtual]

Implements wns::ldk::CommandTypeSpecifierInterface.

Definition at line 124 of file FakeFU.hpp.

virtual size_t wns::ldk::tools::FakeFU::getCommandObjSize (  )  const [inline, virtual]

Implements wns::ldk::CommandTypeSpecifierInterface.

Definition at line 179 of file FakeFU.hpp.

virtual CommandReaderInterface* wns::ldk::tools::FakeFU::getCommandReader ( CommandProxy  )  [inline, virtual]

Implements wns::ldk::CommandTypeSpecifierInterface.

Definition at line 172 of file FakeFU.hpp.

virtual wns::ldk::CopyCommandInterface* wns::ldk::tools::FakeFU::getCopyCommandInterface (  )  const [inline, virtual]

Implements wns::ldk::CommandTypeSpecifierInterface.

Definition at line 166 of file FakeFU.hpp.

virtual fun::FUN* wns::ldk::tools::FakeFU::getFUN (  )  const [inline, virtual]

Implements wns::ldk::CommandTypeSpecifierInterface.

Definition at line 118 of file FakeFU.hpp.

virtual bool wns::ldk::tools::FakeFU::isAcceptingForwarded ( const CompoundPtr compound  )  const [inline, virtual]

Definition at line 76 of file FakeFU.hpp.

virtual void wns::ldk::tools::FakeFU::onDataForwarded ( const CompoundPtr compound  )  [inline, virtual]

Definition at line 112 of file FakeFU.hpp.

virtual void wns::ldk::tools::FakeFU::sendDataForwarded ( const CompoundPtr compound  )  [inline, virtual]

Definition at line 88 of file FakeFU.hpp.

virtual void wns::ldk::tools::FakeFU::wakeupForwarded (  )  [inline, virtual]

Definition at line 100 of file FakeFU.hpp.


Member Data Documentation

Definition at line 185 of file FakeFU.hpp.


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

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