A Discrete-Event Network Simulator
API
ns3::GtsFields Class Reference

Represent the GTS information fields. More...

#include "lr-wpan-fields.h"

+ Collaboration diagram for ns3::GtsFields:

Classes

struct  gtsDescriptor
 GTS Descriptor. More...
 

Public Member Functions

 GtsFields ()
 
Buffer::Iterator Deserialize (Buffer::Iterator i)
 Deserialize the entire GTS fields. More...
 
uint8_t GetGtsDirectionField (void) const
 Get the GTS Direction Field from the GTS Fields. More...
 
uint8_t GetGtsSpecField (void) const
 Get the GTS Specification Field from the GTS Fields. More...
 
uint32_t GetSerializedSize (void) const
 Get the size of the serialized GTS fields. More...
 
Buffer::Iterator Serialize (Buffer::Iterator i) const
 Serialize the entire GTS fields. More...
 
void SetGtsDirectionField (uint8_t gtsDir)
 Set the GTS direction field to the GTS Fields. More...
 
void SetGtsSpecField (uint8_t gtsSpec)
 Set the GTS Specification Field to the GTS Fields. More...
 

Private Attributes

uint8_t m_gtsDirMask
 GTS Direction field Directions Mask (Bit 0-6) More...
 
gtsDescriptor m_gtsList [7]
 GTS List field (maximum descriptors stored == 7) More...
 
uint8_t m_gtsSpecDescCount
 GTS specification field Descriptor Count (Bit 0-2) More...
 
uint8_t m_gtsSpecPermit
 GTS specification field GTS Permit (Bit 7) More...
 

Detailed Description

Represent the GTS information fields.

See IEEE 802.15.4-2011 Section 5.2.2 Figure 39

Definition at line 175 of file lr-wpan-fields.h.

Constructor & Destructor Documentation

◆ GtsFields()

ns3::GtsFields::GtsFields ( )

Definition at line 198 of file lr-wpan-fields.cc.

References m_gtsDirMask, m_gtsSpecDescCount, and m_gtsSpecPermit.

Member Function Documentation

◆ Deserialize()

Buffer::Iterator ns3::GtsFields::Deserialize ( Buffer::Iterator  i)

Deserialize the entire GTS fields.

Parameters
ian iterator which points to where the superframe specification field should be read.
Returns
an iterator.

Definition at line 283 of file lr-wpan-fields.cc.

References ns3::GtsFields::gtsDescriptor::m_gtsDescLength, ns3::GtsFields::gtsDescriptor::m_gtsDescStartSlot, m_gtsList, m_gtsSpecDescCount, ns3::ReadFrom(), ns3::Buffer::Iterator::ReadU8(), SetGtsDirectionField(), and SetGtsSpecField().

Referenced by ns3::BeaconPayloadHeader::Deserialize().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ GetGtsDirectionField()

uint8_t ns3::GtsFields::GetGtsDirectionField ( void  ) const

Get the GTS Direction Field from the GTS Fields.

Returns
The GTS Direction Field

Definition at line 220 of file lr-wpan-fields.cc.

References m_gtsDirMask.

Referenced by ns3::operator<<(), and Serialize().

+ Here is the caller graph for this function:

◆ GetGtsSpecField()

uint8_t ns3::GtsFields::GetGtsSpecField ( void  ) const

Get the GTS Specification Field from the GTS Fields.

Returns
The GTS Spcecification Field

Definition at line 208 of file lr-wpan-fields.cc.

References m_gtsSpecDescCount, and m_gtsSpecPermit.

Referenced by ns3::operator<<(), ns3::BeaconPayloadHeader::Print(), and Serialize().

+ Here is the caller graph for this function:

◆ GetSerializedSize()

uint32_t ns3::GtsFields::GetSerializedSize ( void  ) const

Get the size of the serialized GTS fields.

Returns
the size of the serialized fields.

Definition at line 245 of file lr-wpan-fields.cc.

References m_gtsSpecDescCount.

Referenced by ns3::BeaconPayloadHeader::GetSerializedSize().

+ Here is the caller graph for this function:

◆ Serialize()

Buffer::Iterator ns3::GtsFields::Serialize ( Buffer::Iterator  i) const

Serialize the entire GTS fields.

Parameters
ian iterator which points to where the superframe specification field should be written.
Returns
an iterator.

Definition at line 260 of file lr-wpan-fields.cc.

References GetGtsDirectionField(), GetGtsSpecField(), ns3::GtsFields::gtsDescriptor::m_gtsDescLength, ns3::GtsFields::gtsDescriptor::m_gtsDescStartSlot, m_gtsList, m_gtsSpecDescCount, ns3::WriteTo(), and ns3::Buffer::Iterator::WriteU8().

Referenced by ns3::BeaconPayloadHeader::Serialize().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ SetGtsDirectionField()

void ns3::GtsFields::SetGtsDirectionField ( uint8_t  gtsDir)

Set the GTS direction field to the GTS Fields.

Parameters
gtsDirThe GTS Direction Field to set

Definition at line 238 of file lr-wpan-fields.cc.

References m_gtsDirMask.

Referenced by Deserialize().

+ Here is the caller graph for this function:

◆ SetGtsSpecField()

void ns3::GtsFields::SetGtsSpecField ( uint8_t  gtsSpec)

Set the GTS Specification Field to the GTS Fields.

Parameters
gtsSpecThe GTS Specification Field to set.

Definition at line 230 of file lr-wpan-fields.cc.

References m_gtsSpecDescCount, and m_gtsSpecPermit.

Referenced by Deserialize().

+ Here is the caller graph for this function:

Member Data Documentation

◆ m_gtsDirMask

uint8_t ns3::GtsFields::m_gtsDirMask
private

GTS Direction field Directions Mask (Bit 0-6)

Definition at line 234 of file lr-wpan-fields.h.

Referenced by GtsFields(), GetGtsDirectionField(), and SetGtsDirectionField().

◆ m_gtsList

gtsDescriptor ns3::GtsFields::m_gtsList[7]
private

GTS List field (maximum descriptors stored == 7)

Definition at line 237 of file lr-wpan-fields.h.

Referenced by Deserialize(), and Serialize().

◆ m_gtsSpecDescCount

uint8_t ns3::GtsFields::m_gtsSpecDescCount
private

GTS specification field Descriptor Count (Bit 0-2)

Definition at line 230 of file lr-wpan-fields.h.

Referenced by GtsFields(), Deserialize(), GetGtsSpecField(), GetSerializedSize(), Serialize(), and SetGtsSpecField().

◆ m_gtsSpecPermit

uint8_t ns3::GtsFields::m_gtsSpecPermit
private

GTS specification field GTS Permit (Bit 7)

Definition at line 232 of file lr-wpan-fields.h.

Referenced by GtsFields(), GetGtsSpecField(), and SetGtsSpecField().


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