User Manual, Developers Guide and API Documentation

wns::ldk::Command Class Reference
[Command Provider Interface]

Base class for the PCI of a CommandTypeSpecifier.

Several Commands are grouped together using a CommandPool to form the PCI of a Layer. More...

#include <ldk/Command.hpp>

Inherited by ClassifierCommand, dll::compoundSwitch::CompoundSwitchCommand, dll::UpperCommand, glue::AlohaCommand, glue::arqfsm::selectiverepeat::SelectiveRepeatCommand, glue::arqfsm::stopandwait::StopAndWaitCommand, glue::BERMeasurementReportingCommand, glue::convergence::LowerCommand, glue::convergence::UpperCommand, glue::mac::CSMACACommand, glue::RoutingCommand, ip::ForwardingCommand, ip::IPCommand, lte::controlplane::associationHandler::AssociationCommand, lte::controlplane::bch::LTEBCHCommand, lte::controlplane::flowmanagement::flowhandler::FlowHandlerCommand, lte::controlplane::MapCommand, lte::controlplane::RRCommand, lte::macg::MACgCommand, lte::macr::PhyCommand, lte::rlc::RLCCommand, lte::timing::SchedulerCommand, tcp::CumulativeACKCommand, tcp::TCPCommand, wifimac::convergence::ErrorModellingCommand, wifimac::convergence::PhyUserCommand, wifimac::convergence::PreambleGeneratorCommand, wifimac::convergence::TxDurationSetterCommand, wifimac::draftn::BeaconLinkQualityMeasurementwithMIMOCommand, wifimac::draftn::DeAggregationCommand, wifimac::draftn::FastLinkFeedbackCommand, wifimac::draftn::LongTrainingFieldGeneratorCommand, wifimac::draftn::RTSCTSwithFLACommand, wifimac::IKnowsFrameTypeCommand, wifimac::lowerMAC::DuplicateFilterCommand, wifimac::lowerMAC::RTSCTSCommand, wifimac::management::BeaconCommand, wifimac::pathselection::BeaconLinkQualityMeasurementCommand, wifimac::pathselection::ForwardingCommand, wifimac::pathselection::LinkQualityMeasurementCommand, wimac::AckSwitchCommand, wimac::ErrorModellingCommand, wimac::frame::FrameHeadCommand, wimac::MapCommand, wimac::PhyUserCommand, wimac::relay::RelayMapperCommand, wimac::UpperCommand, wimemac::arq::ARQCommand, wimemac::convergence::ErrorModellingCommand, wimemac::convergence::PhyUserCommand, wimemac::convergence::PreambleGeneratorCommand, wimemac::convergence::TxDurationSetterCommand, wimemac::helper::ARQCommand, wimemac::IKnowsFrameTypeCommand, wimemac::IKnowsTxTypeCommand, wimemac::management::BeaconCommand, wns::ldk::arq::ARQCommand, wns::ldk::arq::PiggyBackerCommand, wns::ldk::command::FlowControlCommand, wns::ldk::concatenation::ConcatenationCommand, wns::ldk::crc::CRCCommand, wns::ldk::EmptyCommand, wns::ldk::harq::HARQCommand, wns::ldk::multiplexer::OpcodeCommand, wns::ldk::probe::bus::PacketCommand, wns::ldk::probe::bus::WindowCommand, wns::ldk::probe::PacketCommand, wns::ldk::probe::TickTackCommand, wns::ldk::probe::WindowCommand, wns::ldk::sar::DynamicSARCommand, wns::ldk::sar::SARCommand, wns::ldk::tools::BottleNeckDetectiveCommand, wns::ldk::tools::InSequenceCheckerCommand, wns::ldk::tools::OverheadCommand, wns::ldk::tools::StubCommand, and wns::scheduler::queue::ISegmentationCommand.

Collaboration diagram for wns::ldk::Command:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 Command ()
virtual Bit getSize () const
virtual ~Command ()

Private Member Functions

void commit ()
 Calculate the size of the Command.
Bit getCommandPoolSize () const
Bit getPayloadSize () const
void setCommandPoolSize (const Bit size)
void setPayloadSize (const Bit size)
bool sizeCommited () const

Private Attributes

Bit commandPoolSize
bool commited
Bit payloadSize

Friends

class CommandProxy


Detailed Description

Derive from Command if you are implementing a CommandTypeSpecifier, that needs additional PCI elements.

The destructor of a Command will be called, when the containing CommandPool is deleted.

Definition at line 51 of file Command.hpp.


Constructor & Destructor Documentation

wns::ldk::Command::Command (  )  [inline]

Definition at line 56 of file Command.hpp.

virtual wns::ldk::Command::~Command (  )  [inline, virtual]

Definition at line 63 of file Command.hpp.


Member Function Documentation

void wns::ldk::Command::commit (  )  [inline, private]

Return the size of the Command in bit. Override this when deriving from Command.

Definition at line 107 of file Command.hpp.

Bit wns::ldk::Command::getCommandPoolSize (  )  const [inline, private]

Definition at line 78 of file Command.hpp.

Bit wns::ldk::Command::getPayloadSize (  )  const [inline, private]

Definition at line 90 of file Command.hpp.

virtual Bit wns::ldk::Command::getSize (  )  const [inline, virtual]

Reimplemented in wns::ldk::tools::OverheadCommand.

Definition at line 67 of file Command.hpp.

void wns::ldk::Command::setCommandPoolSize ( const Bit  size  )  [inline, private]

Definition at line 84 of file Command.hpp.

void wns::ldk::Command::setPayloadSize ( const Bit  size  )  [inline, private]

Definition at line 96 of file Command.hpp.

bool wns::ldk::Command::sizeCommited (  )  const [inline, private]

Definition at line 73 of file Command.hpp.


Friends And Related Function Documentation

friend class CommandProxy [friend]

Definition at line 53 of file Command.hpp.


Member Data Documentation

Definition at line 114 of file Command.hpp.

Definition at line 113 of file Command.hpp.

Definition at line 115 of file Command.hpp.


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

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