INET Framework for OMNeT++/OMNEST
Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | List of all members
inet::ieee80211::Ieee80211DataFrame Class Reference

Class generated from inet/linklayer/ieee80211/mac/Ieee80211Frame.msg:177 by nedtool. More...

#include <Ieee80211Frame_m.h>

Inheritance diagram for inet::ieee80211::Ieee80211DataFrame:
inet::ieee80211::Ieee80211DataOrMgmtFrame inet::ieee80211::Ieee80211TwoAddressFrame inet::ieee80211::Ieee80211OneAddressFrame inet::ieee80211::Ieee80211Frame inet::ieee80211::Ieee80211DataFrameWithSNAP

Public Member Functions

 Ieee80211DataFrame (const char *name=nullptr, short kind=0)
 
 Ieee80211DataFrame (const Ieee80211DataFrame &other)
 
virtual ~Ieee80211DataFrame ()
 
Ieee80211DataFrame & operator= (const Ieee80211DataFrame &other)
 
virtual Ieee80211DataFrame * dup () const override
 
virtual void parsimPack (omnetpp::cCommBuffer *b) const override
 
virtual void parsimUnpack (omnetpp::cCommBuffer *b) override
 
virtual MACAddress & getAddress4 ()
 
virtual const MACAddress & getAddress4 () const
 
virtual void setAddress4 (const MACAddress &address4)
 
virtual uint16_t getQos () const
 
virtual void setQos (uint16_t qos)
 
virtual int getAckPolicy () const
 
virtual void setAckPolicy (int ackPolicy)
 
virtual uint8_t getTid () const
 
virtual void setTid (uint8_t tid)
 
virtual bool getAMsduPresent () const
 
virtual void setAMsduPresent (bool aMsduPresent)
 
- Public Member Functions inherited from inet::ieee80211::Ieee80211DataOrMgmtFrame
 Ieee80211DataOrMgmtFrame (const char *name=nullptr, short kind=0)
 
 Ieee80211DataOrMgmtFrame (const Ieee80211DataOrMgmtFrame &other)
 
virtual ~Ieee80211DataOrMgmtFrame ()
 
Ieee80211DataOrMgmtFrame & operator= (const Ieee80211DataOrMgmtFrame &other)
 
virtual MACAddress & getAddress3 ()
 
virtual const MACAddress & getAddress3 () const
 
virtual void setAddress3 (const MACAddress &address3)
 
virtual short getFragmentNumber () const
 
virtual void setFragmentNumber (short fragmentNumber)
 
virtual uint16_t getSequenceNumber () const
 
virtual void setSequenceNumber (uint16_t sequenceNumber)
 
- Public Member Functions inherited from inet::ieee80211::Ieee80211TwoAddressFrame
 Ieee80211TwoAddressFrame (const char *name=nullptr, short kind=0)
 
 Ieee80211TwoAddressFrame (const Ieee80211TwoAddressFrame &other)
 
virtual ~Ieee80211TwoAddressFrame ()
 
Ieee80211TwoAddressFrame & operator= (const Ieee80211TwoAddressFrame &other)
 
virtual MACAddress & getTransmitterAddress ()
 
virtual const MACAddress & getTransmitterAddress () const
 
virtual void setTransmitterAddress (const MACAddress &transmitterAddress)
 
- Public Member Functions inherited from inet::ieee80211::Ieee80211OneAddressFrame
 Ieee80211OneAddressFrame (const char *name=nullptr, short kind=0)
 
 Ieee80211OneAddressFrame (const Ieee80211OneAddressFrame &other)
 
virtual ~Ieee80211OneAddressFrame ()
 
Ieee80211OneAddressFrame & operator= (const Ieee80211OneAddressFrame &other)
 
- Public Member Functions inherited from inet::ieee80211::Ieee80211Frame
 Ieee80211Frame (const char *name=nullptr, short kind=0)
 
 Ieee80211Frame (const Ieee80211Frame &other)
 
virtual ~Ieee80211Frame ()
 
Ieee80211Frame & operator= (const Ieee80211Frame &other)
 
virtual short getType () const
 
virtual void setType (short type)
 
virtual bool getToDS () const
 
virtual void setToDS (bool toDS)
 
virtual bool getFromDS () const
 
virtual void setFromDS (bool fromDS)
 
virtual bool getRetry () const
 
virtual void setRetry (bool retry)
 
virtual bool getMoreFragments () const
 
virtual void setMoreFragments (bool moreFragments)
 
virtual ::omnetpp::simtime_t getDuration () const
 
virtual void setDuration (::omnetpp::simtime_t duration)
 
virtual short getAID () const
 
virtual void setAID (short AID)
 
virtual MACAddress & getReceiverAddress ()
 
virtual const MACAddress & getReceiverAddress () const
 
virtual void setReceiverAddress (const MACAddress &receiverAddress)
 
virtual ::omnetpp::simtime_t getMACArrive () const
 
virtual void setMACArrive (::omnetpp::simtime_t MACArrive)
 

Protected Member Functions

bool operator== (const Ieee80211DataFrame &)
 
- Protected Member Functions inherited from inet::ieee80211::Ieee80211DataOrMgmtFrame
bool operator== (const Ieee80211DataOrMgmtFrame &)
 
- Protected Member Functions inherited from inet::ieee80211::Ieee80211TwoAddressFrame
bool operator== (const Ieee80211TwoAddressFrame &)
 
- Protected Member Functions inherited from inet::ieee80211::Ieee80211OneAddressFrame
bool operator== (const Ieee80211OneAddressFrame &)
 
- Protected Member Functions inherited from inet::ieee80211::Ieee80211Frame
bool operator== (const Ieee80211Frame &)
 

Protected Attributes

MACAddress address4
 
uint16_t qos
 
int ackPolicy
 
uint8_t tid
 
bool aMsduPresent
 
- Protected Attributes inherited from inet::ieee80211::Ieee80211DataOrMgmtFrame
MACAddress address3
 
short fragmentNumber
 
uint16_t sequenceNumber
 
- Protected Attributes inherited from inet::ieee80211::Ieee80211TwoAddressFrame
MACAddress transmitterAddress
 
- Protected Attributes inherited from inet::ieee80211::Ieee80211Frame
short type
 
bool toDS
 
bool fromDS
 
bool retry
 
bool moreFragments
 
::omnetpp::simtime_t duration
 
short AID
 
MACAddress receiverAddress
 
::omnetpp::simtime_t MACArrive
 

Private Member Functions

void copy (const Ieee80211DataFrame &other)
 

Detailed Description

Class generated from inet/linklayer/ieee80211/mac/Ieee80211Frame.msg:177 by nedtool. 

//
// Format of the 802.11 data frame
//
packet Ieee80211DataFrame extends Ieee80211DataOrMgmtFrame
{
    //  The presence of the Address 4 field is determined by the setting of the To DS and From DS subfields of
    //  the Frame Control field (see below). The QoS Control field is present when the QoS subfield of the Subtype
    //  field is set to 1 (8.3.2.1 Data frame format)
    //  FIXME: byteLength is not a constant value (DATAFRAME_HEADER_MINLENGTH / 8 = 28).
    //  For example, with Address 4 and without QoS the correct length is 34 bytes.
    //  Without Address 4 and QoS the correct value is indeed 28.
    //  With Address 4 and QoS the correct value is indeed 36.
    byteLength = DATAFRAME_HEADER_MINLENGTH / 8;
    type = ST_DATA;         // or ST_DATA_WITH_QOS
    MACAddress address4;    // optional field, exists when toDS and fromDS are true
    uint16 qos;             // TODO nobody uses this currently, only its parts like tid below... 
    int ackPolicy @enum(AckPolicy); //FIXME in real life this is part of the optional qos field above...
    uint8 tid; //FIXME in real life this is part of the optional qos field above...
    bool aMsduPresent = false; // 8.2.4.5.9 A-MSDU Present subfield FIXME in real life this is part of the optional qos field above...
}
//TODO this can be introduced when the SNAP header 
//packet Ieee80211QoSDataFrame extends Ieee80211DataFrame
//{
//    type = ST_DATA_WITH_QOS;
//    byteLength = (DATAFRAME_HEADER_MINLENGTH + QOSCONTROL_BITS) / 8;
//    int ackPolicy @enum(AckPolicy); //FIXME in real life this is part of the optional qos field above...
//    uint8 tid;
//    // TODO: other QoS control field parts
//}

Constructor & Destructor Documentation

inet::ieee80211::Ieee80211DataFrame::Ieee80211DataFrame ( const char *  name = nullptr,
short  kind = 0 
)
inet::ieee80211::Ieee80211DataFrame::Ieee80211DataFrame ( const Ieee80211DataFrame &  other)
virtual inet::ieee80211::Ieee80211DataFrame::~Ieee80211DataFrame ( )
virtual

Member Function Documentation

void inet::ieee80211::Ieee80211DataFrame::copy ( const Ieee80211DataFrame &  other)
private
virtual Ieee80211DataFrame* inet::ieee80211::Ieee80211DataFrame::dup ( ) const
inlineoverridevirtual

Reimplemented from inet::ieee80211::Ieee80211DataOrMgmtFrame.

Reimplemented in inet::ieee80211::Ieee80211DataFrameWithSNAP.

Referenced by inet::ieee80211::Ieee80211MgmtAPSimplified::handleDataFrame(), and inet::ieee80211::Ieee80211MgmtAP::handleDataFrame().

530 {return new Ieee80211DataFrame(*this);}
inet::ieee80211::Ieee80211DataFrame::Ieee80211DataFrame
Ieee80211DataFrame(const char *name=nullptr, short kind=0)
virtual int inet::ieee80211::Ieee80211DataFrame::getAckPolicy ( ) const
virtual

Referenced by inet::ieee80211::RecipientBlockAckAgreement::blockAckPolicyFrameReceived(), inet::ieee80211::Hcf::originatorProcessTransmittedDataFrame(), inet::ieee80211::BlockAckReordering::processReceivedQoSFrame(), and inet::ieee80211::RecipientBlockAckAgreementHandler::qosFrameReceived().

virtual MACAddress& inet::ieee80211::Ieee80211DataFrame::getAddress4 ( )
virtual

Referenced by inet::serializer::Ieee80211Serializer::serialize(), and inet::ieee80211::MsduAggregation::setSubframeAddress().

virtual const MACAddress& inet::ieee80211::Ieee80211DataFrame::getAddress4 ( ) const
inlinevirtual

Referenced by getAddress4().

536 {return const_cast<Ieee80211DataFrame*>(this)->getAddress4();}
inet::ieee80211::Ieee80211DataFrame::getAddress4
virtual MACAddress & getAddress4()
inet::ieee80211::Ieee80211DataFrame::Ieee80211DataFrame
Ieee80211DataFrame(const char *name=nullptr, short kind=0)
virtual bool inet::ieee80211::Ieee80211DataFrame::getAMsduPresent ( ) const
virtual

Referenced by inet::ieee80211::OriginatorQoSAckPolicy::checkAgreementPolicy(), and inet::ieee80211::RecipientQoSMacDataService::dataFrameReceived().

virtual uint16_t inet::ieee80211::Ieee80211DataFrame::getQos ( ) const
virtual

Referenced by inet::serializer::Ieee80211Serializer::serialize().

virtual uint8_t inet::ieee80211::Ieee80211DataFrame::getTid ( ) const
virtual

Referenced by inet::ieee80211::QoSRecoveryProcedure::ackFrameReceived(), inet::ieee80211::MsduAggregation::aggregateFrames(), inet::ieee80211::QoSSequenceNumberAssignment::assignSequenceNumber(), inet::ieee80211::Edca::classifyFrame(), inet::ieee80211::RecipientQoSMacDataService::dataFrameReceived(), inet::ieee80211::MsduDeaggregation::deaggregateFrame(), inet::ieee80211::Ieee80211MgmtAdhoc::decapsulate(), inet::ieee80211::Ieee80211MgmtSTASimplified::decapsulate(), inet::ieee80211::Ieee80211MgmtSTA::decapsulate(), inet::ieee80211::QoSAckHandler::getQoSDataAckStatus(), inet::ieee80211::QoSRecoveryProcedure::getRc(), inet::ieee80211::QoSRecoveryProcedure::incrementCounter(), inet::ieee80211::QoSDuplicateRemoval::isDuplicate(), inet::ieee80211::BasicMsduAggregationPolicy::isEligible(), inet::ieee80211::EdcaTransmitLifetimeHandler::isLifetimeExpired(), inet::ieee80211::OriginatorBlockAckAgreementHandler::processTransmittedDataFrame(), inet::ieee80211::RecipientBlockAckAgreementHandler::qosFrameReceived(), inet::ieee80211::QoSRecoveryProcedure::retryLimitReached(), and inet::ieee80211::Ieee80211MgmtAPBase::sendToUpperLayer().

Ieee80211DataFrame& inet::ieee80211::Ieee80211DataFrame::operator= ( const Ieee80211DataFrame &  other)
bool inet::ieee80211::Ieee80211DataFrame::operator== ( const Ieee80211DataFrame &  )
protected
virtual void inet::ieee80211::Ieee80211DataFrame::parsimPack ( omnetpp::cCommBuffer *  b) const
overridevirtual

Reimplemented from inet::ieee80211::Ieee80211DataOrMgmtFrame.

Reimplemented in inet::ieee80211::Ieee80211DataFrameWithSNAP.

Referenced by inet::ieee80211::doParsimPacking().

virtual void inet::ieee80211::Ieee80211DataFrame::parsimUnpack ( omnetpp::cCommBuffer *  b)
overridevirtual

Reimplemented from inet::ieee80211::Ieee80211DataOrMgmtFrame.

Reimplemented in inet::ieee80211::Ieee80211DataFrameWithSNAP.

Referenced by inet::ieee80211::doParsimUnpacking().

virtual void inet::ieee80211::Ieee80211DataFrame::setAckPolicy ( int  ackPolicy)
virtual
virtual void inet::ieee80211::Ieee80211DataFrame::setAddress4 ( const MACAddress &  address4)
virtual

Referenced by inet::ieee80211::MsduDeaggregation::setExplodedFrameAddress().

virtual void inet::ieee80211::Ieee80211DataFrame::setAMsduPresent ( bool  aMsduPresent)
virtual
virtual void inet::ieee80211::Ieee80211DataFrame::setQos ( uint16_t  qos)
virtual
virtual void inet::ieee80211::Ieee80211DataFrame::setTid ( uint8_t  tid)
virtual

Referenced by inet::ieee80211::MsduDeaggregation::deaggregateFrame(), inet::ieee80211::Ieee80211MgmtAdhoc::encapsulate(), inet::ieee80211::Ieee80211MgmtSTASimplified::encapsulate(), and inet::ieee80211::Ieee80211MgmtSTA::encapsulate().

Member Data Documentation

int inet::ieee80211::Ieee80211DataFrame::ackPolicy
protected
MACAddress inet::ieee80211::Ieee80211DataFrame::address4
protected
bool inet::ieee80211::Ieee80211DataFrame::aMsduPresent
protected
uint16_t inet::ieee80211::Ieee80211DataFrame::qos
protected
uint8_t inet::ieee80211::Ieee80211DataFrame::tid
protected
The documentation for this class was generated from the following file: