INET Framework for OMNeT++/OMNEST
inet::ieee80211::Ieee80211DataOrMgmtHeader Class Reference

Class generated from inet/linklayer/ieee80211/mac/Ieee80211Frame.msg:188 by opp_msgtool. More...

#include <Ieee80211Frame_m.h>

Inheritance diagram for inet::ieee80211::Ieee80211DataOrMgmtHeader:
inet::ieee80211::Ieee80211TwoAddressHeader inet::ieee80211::Ieee80211OneAddressHeader inet::ieee80211::Ieee80211MacHeader inet::FieldsChunk inet::Chunk inet::IPrintableObject inet::IRegionTaggedObject inet::ieee80211::Ieee80211DataHeader inet::ieee80211::Ieee80211MgmtHeader inet::ieee80211::Ieee80211ActionFrame inet::ieee80211::Ieee80211AddbaRequest inet::ieee80211::Ieee80211AddbaResponse inet::ieee80211::Ieee80211Delba

Public Member Functions

 Ieee80211DataOrMgmtHeader ()
 
 Ieee80211DataOrMgmtHeader (const Ieee80211DataOrMgmtHeader &other)
 
virtual ~Ieee80211DataOrMgmtHeader ()
 
Ieee80211DataOrMgmtHeaderoperator= (const Ieee80211DataOrMgmtHeader &other)
 
virtual Ieee80211DataOrMgmtHeaderdup () const override
 
virtual void parsimPack (omnetpp::cCommBuffer *b) const override
 
virtual void parsimUnpack (omnetpp::cCommBuffer *b) override
 
virtual const ::inet::MacAddressgetAddress3 () const
 
virtual ::inet::MacAddressgetAddress3ForUpdate ()
 
virtual void setAddress3 (const ::inet::MacAddress &address3)
 
virtual short getFragmentNumber () const
 
virtual void setFragmentNumber (short fragmentNumber)
 
virtual const SequenceNumberCyclicgetSequenceNumber () const
 
virtual SequenceNumberCyclicgetSequenceNumberForUpdate ()
 
virtual void setSequenceNumber (const SequenceNumberCyclic &sequenceNumber)
 
- Public Member Functions inherited from inet::ieee80211::Ieee80211TwoAddressHeader
 Ieee80211TwoAddressHeader ()
 
 Ieee80211TwoAddressHeader (const Ieee80211TwoAddressHeader &other)
 
virtual ~Ieee80211TwoAddressHeader ()
 
Ieee80211TwoAddressHeaderoperator= (const Ieee80211TwoAddressHeader &other)
 
virtual const ::inet::MacAddressgetTransmitterAddress () const
 
virtual ::inet::MacAddressgetTransmitterAddressForUpdate ()
 
virtual void setTransmitterAddress (const ::inet::MacAddress &transmitterAddress)
 
- Public Member Functions inherited from inet::ieee80211::Ieee80211OneAddressHeader
 Ieee80211OneAddressHeader ()
 
 Ieee80211OneAddressHeader (const Ieee80211OneAddressHeader &other)
 
virtual ~Ieee80211OneAddressHeader ()
 
Ieee80211OneAddressHeaderoperator= (const Ieee80211OneAddressHeader &other)
 
- Public Member Functions inherited from inet::ieee80211::Ieee80211MacHeader
 Ieee80211MacHeader ()
 
 Ieee80211MacHeader (const Ieee80211MacHeader &other)
 
virtual ~Ieee80211MacHeader ()
 
Ieee80211MacHeaderoperator= (const Ieee80211MacHeader &other)
 
virtual Ieee80211FrameType getType () const
 
virtual void setType (Ieee80211FrameType type)
 
virtual bool getToDS () const
 
virtual void setToDS (bool toDS)
 
virtual bool getFromDS () const
 
virtual void setFromDS (bool fromDS)
 
virtual bool getMoreFragments () const
 
virtual void setMoreFragments (bool moreFragments)
 
virtual bool getRetry () const
 
virtual void setRetry (bool retry)
 
virtual bool getPowerMgmt () const
 
virtual void setPowerMgmt (bool powerMgmt)
 
virtual bool getMoreData () const
 
virtual void setMoreData (bool moreData)
 
virtual bool getProtectedFrame () const
 
virtual void setProtectedFrame (bool protectedFrame)
 
virtual bool getOrder () const
 
virtual void setOrder (bool order)
 
virtual ::omnetpp::simtime_t getDurationField () const
 
virtual void setDurationField (::omnetpp::simtime_t durationField)
 
virtual short getAID () const
 
virtual void setAID (short AID)
 
virtual const ::inet::MacAddressgetReceiverAddress () const
 
virtual ::inet::MacAddressgetReceiverAddressForUpdate ()
 
virtual void setReceiverAddress (const ::inet::MacAddress &receiverAddress)
 
virtual ::omnetpp::simtime_t getMACArrive () const
 
virtual void setMACArrive (::omnetpp::simtime_t MACArrive)
 
virtual uint8_t getProtocolVersion () const
 
virtual uint8_t getFrameType () const
 
virtual uint8_t getSubType () const
 
virtual void setType (uint8_t protocolVersion, uint8_t frameType, uint8_t subType)
 
- Public Member Functions inherited from inet::FieldsChunk
 FieldsChunk ()
 
 FieldsChunk (const FieldsChunk &other)
 
virtual ~FieldsChunk ()
 
virtual void parsimPack (cCommBuffer *buffer) const override
 
virtual void parsimUnpack (cCommBuffer *buffer) override
 
virtual void handleChange () override
 
virtual ChunkType getChunkType () const override
 Returns the type of this chunk as an enum member. More...
 
virtual bool containsSameData (const Chunk &other) const override
 Returns true if the two chunks represent the same binary data. More...
 
virtual b getChunkLength () const override
 Returns the length of data represented by this chunk. More...
 
virtual void setChunkLength (b chunkLength)
 
virtual void addChunkLength (b chunkLength)
 
virtual std::ostream & printFieldsToStream (std::ostream &stream, int level, int evFlags=0) const override
 Prints an optinally formatted human readable string representation of the feilds of this chunk to the given stream. More...
 
- Public Member Functions inherited from inet::Chunk
 Chunk ()
 
 Chunk (const Chunk &other)
 
virtual const Ptr< ChunkdupShared () const
 Returns a mutable copy of this chunk in a shared pointer. More...
 
virtual void forEachChild (cVisitor *v) override
 
virtual bool isMutable () const
 
virtual bool isImmutable () const
 
virtual void markImmutable ()
 
void markMutableIfExclusivelyOwned ()
 
virtual bool isComplete () const
 
virtual bool isIncomplete () const
 
virtual void markIncomplete ()
 
virtual bool isCorrect () const
 
virtual bool isIncorrect () const
 
virtual void markIncorrect ()
 
virtual bool isProperlyRepresented () const
 
virtual bool isImproperlyRepresented () const
 
virtual void markImproperlyRepresented ()
 
virtual void moveIterator (Iterator &iterator, b length) const
 
virtual void seekIterator (Iterator &iterator, b position) const
 
virtual bool canInsertAtFront (const Ptr< const Chunk > &chunk) const
 Returns true if this chunk is capable of representing the result. More...
 
virtual bool canInsertAtBack (const Ptr< const Chunk > &chunk) const
 Returns true if this chunk is capable of representing the result. More...
 
virtual bool canInsertAt (const Ptr< const Chunk > &chunk, b offset) const
 Returns true if this chunk is capable of representing the result. More...
 
void insertAtFront (const Ptr< const Chunk > &chunk)
 Inserts the provided chunk at the beginning of this chunk. More...
 
void insertAtBack (const Ptr< const Chunk > &chunk)
 Inserts the provided chunk at the end of this chunk. More...
 
void insertAt (const Ptr< const Chunk > &chunk, b offset)
 Inserts the provided chunk into this chunk. More...
 
virtual bool canRemoveAtFront (b length) const
 Returns true if this chunk is capable of representing the result. More...
 
virtual bool canRemoveAtBack (b length) const
 Returns true if this chunk is capable of representing the result. More...
 
virtual bool canRemoveAt (b offset, b length) const
 Returns true if this chunk is capable of representing the result. More...
 
void removeAtFront (b length)
 Removes the requested part from the beginning of this chunk. More...
 
void removeAtBack (b length)
 Removes the requested part from the end of this chunk. More...
 
void removeAt (b offset, b length)
 Removes the requested part from this chunk. More...
 
int getChunkId () const
 Returns the sequentially assigned id. More...
 
virtual bool isEmpty () const
 Returns true if this chunk contains no data. More...
 
const Ptr< Chunksimplify () const
 Returns the simplified representation of this chunk eliminating all potential redundancies. More...
 
const Ptr< Chunkpeek (const Iterator &iterator, b length=unspecifiedLength, int flags=0) const
 Returns the designated part of the data represented by this chunk in its default representation. More...
 
template<typename T >
bool has (const Iterator &iterator, b length=unspecifiedLength) const
 Returns whether if the designated part of the data is available in the requested representation. More...
 
template<typename T >
const Ptr< Tpeek (const Iterator &iterator, b length=unspecifiedLength, int flags=0) const
 Returns the designated part of the data represented by this chunk in the requested representation. More...
 
virtual SharingRegionTagSetgetRegionTags () override
 Returns all region tags. More...
 
int getNumTags () const
 Returns the number of chunk tags. More...
 
const Ptr< const TagBasegetTag (int index) const
 Returns the chunk tag at the given index. More...
 
void clearTags (b offset=b(0), b length=b(-1))
 Clears the set of chunk tags in the given region. More...
 
void copyTags (const Chunk &source, b sourceOffset=b(0), b offset=b(0), b length=b(-1))
 Copies the set of chunk tags from the source region to the provided region. More...
 
template<typename T >
const Ptr< const TfindTag (b offset=b(0), b length=b(-1)) const
 Returns the chunk tag for the provided type and range, or returns nullptr if no such chunk tag is found. More...
 
template<typename T >
const Ptr< const TgetTag (b offset=b(0), b length=b(-1)) const
 Returns the chunk tag for the provided type and range, or throws an exception if no such chunk tag is found. More...
 
template<typename T >
void mapAllTags (b offset, b length, std::function< void(b, b, const Ptr< const T > &)> f) const
 Maps all tags in the provided range to to the function. More...
 
template<typename T >
void mapAllTagsForUpdate (b offset, b length, std::function< void(b, b, const Ptr< T > &)> f)
 Maps all tags in the provided range to to the function. More...
 
template<typename T >
std::vector< SharingRegionTagSet::RegionTag< const T > > getAllTags (b offset=b(0), b length=b(-1)) const
 Returns all chunk tags for the provided type and range in a detached vector of region tags. More...
 
template<typename T >
std::vector< SharingRegionTagSet::RegionTag< T > > getAllTagsForUpdate (b offset=b(0), b length=b(-1))
 Returns all chunk tags for the provided type and range in a detached vector of region tags. More...
 
template<typename T >
const Ptr< TaddTag (b offset=b(0), b length=b(-1))
 Returns a newly added chunk tag for the provided type and range, or throws an exception if such a chunk tag is already present. More...
 
template<typename T >
const Ptr< TaddTagIfAbsent (b offset=b(0), b length=b(-1))
 Returns a newly added chunk tag for the provided type and range if absent, or returns the chunk tag that is already present. More...
 
template<typename T >
std::vector< SharingRegionTagSet::RegionTag< T > > addTagsWhereAbsent (b offset=b(0), b length=b(-1))
 Returns the newly added chunk tags for the provided type and range where the tag is absent. More...
 
template<typename T >
const Ptr< TremoveTag (b offset, b length)
 Removes the chunk tag for the provided type and range, or throws an exception if no such chunk tag is found. More...
 
template<typename T >
const Ptr< TremoveTagIfPresent (b offset, b length)
 Removes the chunk tag for the provided type and range if present, or returns nullptr if no such chunk tag is found. More...
 
template<typename T >
std::vector< SharingRegionTagSet::RegionTag< T > > removeTagsWherePresent (b offset, b length)
 Removes and returns all chunk tags for the provided type and range. More...
 
virtual std::ostream & printToStream (std::ostream &stream, int level, int evFlags=0) const override
 Prints an optinally formatted human readable string representation of the data present in this chunk to the given stream. More...
 
virtual std::string str () const override
 Returns a human readable string representation of the data present in this chunk. More...
 
- Public Member Functions inherited from inet::IPrintableObject
virtual ~IPrintableObject ()
 
virtual std::string printToString () const
 
virtual std::string printToString (int level, int evFlags=0) const
 
virtual std::string getInfoStringRepresentation (int evFlags=0) const
 
virtual std::string getDetailStringRepresentation (int evFlags=0) const
 
virtual std::string getDebugStringRepresentation (int evFlags=0) const
 
virtual std::string getTraceStringRepresentation (int evFlags=0) const
 
virtual std::string getCompleteStringRepresentation (int evFlags=0) const
 

Protected Member Functions

bool operator== (const Ieee80211DataOrMgmtHeader &)=delete
 
- Protected Member Functions inherited from inet::ieee80211::Ieee80211TwoAddressHeader
bool operator== (const Ieee80211TwoAddressHeader &)=delete
 
- Protected Member Functions inherited from inet::ieee80211::Ieee80211OneAddressHeader
bool operator== (const Ieee80211OneAddressHeader &)=delete
 
- Protected Member Functions inherited from inet::ieee80211::Ieee80211MacHeader
bool operator== (const Ieee80211MacHeader &)=delete
 
- Protected Member Functions inherited from inet::FieldsChunk
const std::vector< uint8_t > * getSerializedBytes () const
 
void setSerializedBytes (const std::vector< uint8_t > *bytes) const
 
virtual const Ptr< ChunkpeekUnchecked (PeekPredicate predicate, PeekConverter converter, const Iterator &iterator, b length, int flags) const override
 
- Protected Member Functions inherited from inet::Chunk
int getBinDumpNumLines () const
 
int getHexDumpNumLines () const
 
const char * getBinDumpLine (int index)
 
const char * getHexDumpLine (int index)
 
const SharingRegionTagSet::RegionTag< TagBase > & _getTag (int index) const
 
void checkMutable () const
 
virtual void doInsertAtFront (const Ptr< const Chunk > &chunk)
 
virtual void doInsertAtBack (const Ptr< const Chunk > &chunk)
 
virtual void doInsertAt (const Ptr< const Chunk > &chunk, b offset)
 
virtual void doRemoveAtFront (b length)
 
virtual void doRemoveAtBack (b length)
 
virtual void doRemoveAt (b offset, b length)
 
template<typename T >
const Ptr< TpeekConverted (const Iterator &iterator, b length, int flags) const
 
template<typename T >
const Ptr< TcheckPeekResult (const Ptr< T > &chunk, int flags) const
 

Protected Attributes

::inet::MacAddress address3
 
short fragmentNumber = 0
 
SequenceNumberCyclic sequenceNumber
 
- Protected Attributes inherited from inet::ieee80211::Ieee80211TwoAddressHeader
::inet::MacAddress transmitterAddress
 
- Protected Attributes inherited from inet::ieee80211::Ieee80211MacHeader
Ieee80211FrameType type = static_cast<inet::ieee80211::Ieee80211FrameType>(-1)
 
bool toDS = false
 
bool fromDS = false
 
bool moreFragments = false
 
bool retry = false
 
bool powerMgmt = false
 
bool moreData = false
 
bool protectedFrame = false
 
bool order = false
 
::omnetpp::simtime_t durationField = -1
 
short AID = -1
 
::inet::MacAddress receiverAddress
 
::omnetpp::simtime_t MACArrive = SIMTIME_ZERO
 
- Protected Attributes inherited from inet::FieldsChunk
b chunkLength
 
const std::vector< uint8_t > * serializedBytes
 The serialized representation of this chunk or nullptr if not available. More...
 
- Protected Attributes inherited from inet::Chunk
int id
 The id is automatically assigned sequentially during construction. More...
 
int flags
 The boolean chunk flags are merged into a single integer. More...
 
SharingRegionTagSet regionTags
 The set of region tags attached to the data represented by this chunk. More...
 
const typedef Ptr< Chunk >(* PeekConverter )(const Ptr< Chunk > &chunk, const Chunk::Iterator &iterator, b length, int flags)
 

Private Member Functions

void copy (const Ieee80211DataOrMgmtHeader &other)
 

Additional Inherited Members

- Public Types inherited from inet::Chunk
enum  ChunkType {
  CT_EMPTY, CT_BITCOUNT, CT_BITS, CT_BYTECOUNT,
  CT_BYTES, CT_SLICE, CT_ENCRYPTED, CT_CPACKET,
  CT_SEQUENCE, CT_FIELDS
}
 This enum is used to avoid std::dynamic_cast and dynamicPtrCast. More...
 
enum  PeekFlag {
  PF_ALLOW_NULLPTR = (1 << 0), PF_ALLOW_EMPTY = (1 << 1), PF_ALLOW_INCOMPLETE = (1 << 2), PF_ALLOW_INCORRECT = (1 << 3),
  PF_ALLOW_IMPROPERLY_REPRESENTED = (1 << 4), PF_ALLOW_SERIALIZATION = (1 << 5), PF_ALLOW_ALL = -1
}
 This enum specifies bitmasks for the flags argument of various peek functions. More...
 
- Public Types inherited from inet::IPrintableObject
enum  PrintLevel {
  PRINT_LEVEL_TRACE, PRINT_LEVEL_DEBUG, PRINT_LEVEL_DETAIL, PRINT_LEVEL_INFO,
  PRINT_LEVEL_COMPLETE = INT_MIN
}
 
enum  PrintFlag { PRINT_FLAG_FORMATTED = (1 << 0), PRINT_FLAG_MULTILINE = (1 << 1) }
 
- Static Public Member Functions inherited from inet::Chunk
static void serialize (MemoryOutputStream &stream, const Ptr< const Chunk > &chunk, b offset=b(0), b length=b(-1))
 Serializes a chunk into the given stream. More...
 
static const Ptr< Chunkdeserialize (MemoryInputStream &stream, const std::type_info &typeInfo)
 Deserializes a chunk from the given stream. More...
 
- Static Public Attributes inherited from inet::Chunk
static const b unspecifiedLength = b(-std::numeric_limits<int64_t>::max())
 
static bool enableImplicitChunkSerialization = false
 Peeking some part into a chunk that requires automatic serialization will throw an exception when implicit chunk serialization is disabled. More...
 
static int nextId = 0
 
- Protected Types inherited from inet::Chunk
enum  ChunkFlag { CF_IMMUTABLE = (1 << 0), CF_INCOMPLETE = (1 << 1), CF_INCORRECT = (1 << 2), CF_IMPROPERLY_REPRESENTED = (1 << 3) }
 This enum specifies bitmasks for the flags field of Chunk. More...
 
typedef bool(* PeekPredicate) (const Ptr< Chunk > &)
 
- Static Protected Member Functions inherited from inet::FieldsChunk
static const Ptr< ChunkconvertChunk (const std::type_info &typeInfo, const Ptr< Chunk > &chunk, b offset, b length, int flags)
 
- Static Protected Member Functions inherited from inet::Chunk
static const Ptr< ChunkconvertChunk (const std::type_info &typeInfo, const Ptr< Chunk > &chunk, b offset, b length, int flags)
 Creates a new chunk of the given type that represents the designated part of the provided chunk. More...
 

Detailed Description

Class generated from inet/linklayer/ieee80211/mac/Ieee80211Frame.msg:188 by opp_msgtool.

//
// Common base class for 802.11 data and management frames
//
class Ieee80211DataOrMgmtHeader extends Ieee80211TwoAddressHeader
{
    chunkLength = LENGTH_MGMT - B(4);
    MacAddress address3;
    short fragmentNumber;
    SequenceNumberCyclic sequenceNumber;
}

Constructor & Destructor Documentation

◆ Ieee80211DataOrMgmtHeader() [1/2]

inet::ieee80211::Ieee80211DataOrMgmtHeader::Ieee80211DataOrMgmtHeader ( )

◆ Ieee80211DataOrMgmtHeader() [2/2]

inet::ieee80211::Ieee80211DataOrMgmtHeader::Ieee80211DataOrMgmtHeader ( const Ieee80211DataOrMgmtHeader other)

◆ ~Ieee80211DataOrMgmtHeader()

virtual inet::ieee80211::Ieee80211DataOrMgmtHeader::~Ieee80211DataOrMgmtHeader ( )
virtual

Member Function Documentation

◆ copy()

void inet::ieee80211::Ieee80211DataOrMgmtHeader::copy ( const Ieee80211DataOrMgmtHeader other)
private

◆ dup()

◆ getAddress3()

virtual const ::inet::MacAddress& inet::ieee80211::Ieee80211DataOrMgmtHeader::getAddress3 ( ) const
virtual

◆ getAddress3ForUpdate()

virtual ::inet::MacAddress& inet::ieee80211::Ieee80211DataOrMgmtHeader::getAddress3ForUpdate ( )
inline
579 { handleChange();return const_cast<::inet::MacAddress&>(const_cast<Ieee80211DataOrMgmtHeader*>(this)->getAddress3());}

◆ getFragmentNumber()

virtual short inet::ieee80211::Ieee80211DataOrMgmtHeader::getFragmentNumber ( ) const
virtual

◆ getSequenceNumber()

virtual const SequenceNumberCyclic& inet::ieee80211::Ieee80211DataOrMgmtHeader::getSequenceNumber ( ) const
virtual

◆ getSequenceNumberForUpdate()

virtual SequenceNumberCyclic& inet::ieee80211::Ieee80211DataOrMgmtHeader::getSequenceNumberForUpdate ( )
inlinevirtual
586 { handleChange();return const_cast<SequenceNumberCyclic&>(const_cast<Ieee80211DataOrMgmtHeader*>(this)->getSequenceNumber());}

◆ operator=()

Ieee80211DataOrMgmtHeader& inet::ieee80211::Ieee80211DataOrMgmtHeader::operator= ( const Ieee80211DataOrMgmtHeader other)

◆ operator==()

bool inet::ieee80211::Ieee80211DataOrMgmtHeader::operator== ( const Ieee80211DataOrMgmtHeader )
protecteddelete

◆ parsimPack()

◆ parsimUnpack()

◆ setAddress3()

virtual void inet::ieee80211::Ieee80211DataOrMgmtHeader::setAddress3 ( const ::inet::MacAddress address3)
virtual

◆ setFragmentNumber()

virtual void inet::ieee80211::Ieee80211DataOrMgmtHeader::setFragmentNumber ( short  fragmentNumber)
virtual

◆ setSequenceNumber()

virtual void inet::ieee80211::Ieee80211DataOrMgmtHeader::setSequenceNumber ( const SequenceNumberCyclic sequenceNumber)
virtual

Member Data Documentation

◆ address3

::inet::MacAddress inet::ieee80211::Ieee80211DataOrMgmtHeader::address3
protected

◆ fragmentNumber

short inet::ieee80211::Ieee80211DataOrMgmtHeader::fragmentNumber = 0
protected

◆ sequenceNumber

SequenceNumberCyclic inet::ieee80211::Ieee80211DataOrMgmtHeader::sequenceNumber
protected

The documentation for this class was generated from the following file:
inet::ieee80211::Ieee80211DataOrMgmtHeader::Ieee80211DataOrMgmtHeader
Ieee80211DataOrMgmtHeader()
inet::FieldsChunk::handleChange
virtual void handleChange() override
Definition: FieldsChunk.cc:50
inet::ieee80211::Ieee80211DataOrMgmtHeader::getAddress3
virtual const ::inet::MacAddress & getAddress3() const
inet::ieee80211::Ieee80211DataOrMgmtHeader::getSequenceNumber
virtual const SequenceNumberCyclic & getSequenceNumber() const
inet::MacAddress
Stores an IEEE 802 MAC address (6 octets = 48 bits).
Definition: MacAddress.h:24