Represent the GTS information fields. More...

#include "lr-wpan-fields.h"

Collaboration diagram for ns3::lrwpan::GtsFields:

Classes
struct	GtsDescriptor
	GTS Descriptor. More...

Public Member Functions
	GtsFields ()

Buffer::Iterator	Deserialize (Buffer::Iterator i)
	Deserialize the entire GTS fields.

uint8_t	GetGtsDirectionField () const
	Get the GTS Direction Field from the GTS Fields.

bool	GetGtsPermit () const
	Get the GTS Specification Permit.

uint8_t	GetGtsSpecField () const
	Get the GTS Specification Field from the GTS Fields.

uint32_t	GetSerializedSize () const
	Get the size of the serialized GTS fields.

Buffer::Iterator	Serialize (Buffer::Iterator i) const
	Serialize the entire GTS fields.

void	SetGtsDirectionField (uint8_t gtsDir)
	Set the GTS direction field to the GTS Fields.

void	SetGtsSpecField (uint8_t gtsSpec)
	Set the GTS Specification Field to the GTS Fields.

Private Attributes
uint8_t	m_gtsDirMask
	GTS Direction field Directions Mask (Bit 0-6)

GtsDescriptor	m_gtsList [7]
	GTS List field (maximum descriptors stored == 7)

uint8_t	m_gtsSpecDescCount
	GTS specification field Descriptor Count (Bit 0-2)

uint8_t	m_gtsSpecPermit
	GTS specification field GTS Permit (Bit 7)

Detailed Description

Represent the GTS information fields.

See IEEE 802.15.4-2011 Section 5.2.2 Figure 39

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

Constructor & Destructor Documentation

◆ GtsFields()

ns3::lrwpan::GtsFields::GtsFields ( )

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

References m_gtsDirMask, m_gtsSpecDescCount, and m_gtsSpecPermit.

Member Function Documentation

◆ Deserialize()

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

Deserialize the entire GTS fields.

Parameters

i	an iterator which points to where the superframe specification field should be read.

Returns: an iterator.

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

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetGtsDirectionField()

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

Get the GTS Direction Field from the GTS Fields.

Returns: The GTS Direction Field

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

References m_gtsDirMask.

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

Here is the caller graph for this function:

◆ GetGtsPermit()

bool ns3::lrwpan::GtsFields::GetGtsPermit ( ) const

Get the GTS Specification Permit.

TRUE if coordinator is accepting GTS requests.

Returns: True if the coordinator is accepting GTS request.

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

References m_gtsSpecPermit.

Referenced by ns3::lrwpan::LrWpanMac::ReceiveBeacon().

Here is the caller graph for this function:

◆ GetGtsSpecField()

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

Get the GTS Specification Field from the GTS Fields.

Returns: The GTS Specification Field

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

References m_gtsSpecDescCount, and m_gtsSpecPermit.

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

Here is the caller graph for this function:

◆ GetSerializedSize()

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

Get the size of the serialized GTS fields.

Returns: the size of the serialized fields.

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

References m_gtsSpecDescCount.

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

Here is the caller graph for this function:

◆ Serialize()

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

Serialize the entire GTS fields.

Parameters

i	an iterator which points to where the superframe specification field should be written.

Returns: an iterator.

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

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetGtsDirectionField()

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

Set the GTS direction field to the GTS Fields.

Parameters

gtsDir The GTS Direction Field to set

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

References m_gtsDirMask.

Referenced by Deserialize().

Here is the caller graph for this function:

◆ SetGtsSpecField()

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

Set the GTS Specification Field to the GTS Fields.

Parameters

gtsSpec The GTS Specification Field to set.

Definition at line 203 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::lrwpan::GtsFields::m_gtsDirMask

private

GTS Direction field Directions Mask (Bit 0-6)

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

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

◆ m_gtsList

GtsDescriptor ns3::lrwpan::GtsFields::m_gtsList[7]

private

GTS List field (maximum descriptors stored == 7)

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

Referenced by Deserialize(), and Serialize().

◆ m_gtsSpecDescCount

uint8_t ns3::lrwpan::GtsFields::m_gtsSpecDescCount

private

GTS specification field Descriptor Count (Bit 0-2)

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

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

◆ m_gtsSpecPermit

uint8_t ns3::lrwpan::GtsFields::m_gtsSpecPermit

private

GTS specification field GTS Permit (Bit 7)

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

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

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

src/lr-wpan/model/lr-wpan-fields.h
src/lr-wpan/model/lr-wpan-fields.cc

Classes

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ GtsFields()

Member Function Documentation

◆ Deserialize()

◆ GetGtsDirectionField()

◆ GetGtsPermit()

◆ GetGtsSpecField()

◆ GetSerializedSize()

◆ Serialize()

◆ SetGtsDirectionField()

◆ SetGtsSpecField()

Member Data Documentation

◆ m_gtsDirMask

◆ m_gtsList

◆ m_gtsSpecDescCount

◆ m_gtsSpecPermit