#include "ofdm-downlink-frame-prefix.h"

Inheritance diagram for ns3::OfdmDownlinkFramePrefix:

Collaboration diagram for ns3::OfdmDownlinkFramePrefix:

Public Member Functions
	OfdmDownlinkFramePrefix ()

	~OfdmDownlinkFramePrefix () override

void	AddDlFramePrefixElement (DlFramePrefixIe dlFramePrefixElement)
	Add DL frame prefix element field.

uint32_t	Deserialize (Buffer::Iterator start) override

Mac48Address	GetBaseStationId () const
	Get base station ID field.

uint8_t	GetConfigurationChangeCount () const
	Get configuration change count field.

std::vector< DlFramePrefixIe >	GetDlFramePrefixElements () const
	Get DL frame prefix elements.

uint32_t	GetFrameNumber () const
	Get frame number field.

uint8_t	GetHcs () const
	Get HCS field.

std::string	GetName () const
	Get name field.

uint32_t	GetSerializedSize () const override

void	Print (std::ostream &os) const override

void	Serialize (Buffer::Iterator start) const override

void	SetBaseStationId (Mac48Address baseStationId)
	Set base station ID field.

void	SetConfigurationChangeCount (uint8_t configurationChangeCount)
	Set configuration change count field.

void	SetFrameNumber (uint32_t frameNumber)
	Set frame number field.

void	SetHcs (uint8_t hcs)
	Set HCS field.

Public Member Functions inherited from ns3::Header
	~Header () override

uint32_t	Deserialize (Buffer::Iterator start) override=0

virtual uint32_t	Deserialize (Buffer::Iterator start)=0
	Deserialize the object from a buffer iterator.

virtual uint32_t	Deserialize (Buffer::Iterator start, Buffer::Iterator end)
	Deserialize the object from a buffer iterator.

virtual uint32_t	GetSerializedSize () const =0

void	Print (std::ostream &os) const override=0

virtual void	Serialize (Buffer::Iterator start) const =0

virtual uint32_t	Deserialize (Buffer::Iterator start)=0
	Deserialize the object from a buffer iterator.

virtual uint32_t	Deserialize (Buffer::Iterator start, Buffer::Iterator end)
	Deserialize the object from a buffer iterator.

virtual void	Print (std::ostream &os) const =0
	Print the object contents.

Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
	Virtual destructor.

void	GetAttribute (std::string name, AttributeValue &value) const
	Get the value of an attribute, raising fatal errors if unsuccessful.

bool	GetAttributeFailSafe (std::string name, AttributeValue &value) const
	Get the value of an attribute without raising errors.

virtual TypeId	GetInstanceTypeId () const =0
	Get the most derived TypeId for this Object.

void	SetAttribute (std::string name, const AttributeValue &value)
	Set a single attribute, raising fatal errors if unsuccessful.

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)
	Set a single attribute without raising errors.

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)
	Connect a TraceSource to a Callback with a context.

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
	Connect a TraceSource to a Callback without a context.

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected with a context.

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected without a context.

Static Public Member Functions
static TypeId	GetTypeId ()
	Register this type.

Static Public Member Functions inherited from ns3::Header
static TypeId	GetTypeId ()
	Get the type ID.

Static Public Member Functions inherited from ns3::Chunk
static TypeId	GetTypeId ()
	Get the type ID.

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId ()
	Get the type ID.

Private Attributes
Mac48Address	m_baseStationId
	base station ID

uint8_t	m_configurationChangeCount
	shall actually be only 4 LSB of the same field in DCD

std::vector< DlFramePrefixIe >	m_dlFramePrefixElements
	vector of dl frame prefix elements

uint32_t	m_frameNumber
	shall actually be only 4 LSB of the same field in OFDM DCD Channel Encodings

uint8_t	m_hcs
	Header Check Sequence.

Additional Inherited Members
Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)
	Complete construction of ObjectBase; invoked by derived classes.

virtual void	NotifyConstructionCompleted ()
	Notifier called once the ObjectBase is fully constructed.

Related Functions inherited from ns3::ObjectBase
static TypeId	GetObjectIid ()
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly.

Detailed Description

OfdmDownlinkFramePrefix.

Definition at line 140 of file ofdm-downlink-frame-prefix.h.

Constructor & Destructor Documentation

◆ OfdmDownlinkFramePrefix()

ns3::OfdmDownlinkFramePrefix::OfdmDownlinkFramePrefix ( )

Definition at line 132 of file ofdm-downlink-frame-prefix.cc.

◆ ~OfdmDownlinkFramePrefix()

ns3::OfdmDownlinkFramePrefix::~OfdmDownlinkFramePrefix ( )

override

Definition at line 140 of file ofdm-downlink-frame-prefix.cc.

Member Function Documentation

◆ AddDlFramePrefixElement()

void ns3::OfdmDownlinkFramePrefix::AddDlFramePrefixElement ( DlFramePrefixIe dlFramePrefixElement )

Add DL frame prefix element field.

Parameters

dlFramePrefixElement the DL frame prefix element

Definition at line 174 of file ofdm-downlink-frame-prefix.cc.

References m_dlFramePrefixElements.

Referenced by Deserialize().

Here is the caller graph for this function:

◆ Deserialize()

uint32_t ns3::OfdmDownlinkFramePrefix::Deserialize ( Buffer::Iterator start )

overridevirtual

Parameters

start an iterator which points to where the header should read from.

Returns: the number of bytes read.

This method is used by Packet::RemoveHeader to re-create a header from the byte buffer of a packet. The data read is expected to match bit-for-bit the representation of this header in real networks.

Note that data is not actually removed from the buffer to which the iterator points. Both Packet::RemoveHeader() and Packet::PeekHeader() call Deserialize(), but only the RemoveHeader() has additional statements to remove the header bytes from the underlying buffer and associated metadata.

Implements ns3::Header.

Definition at line 260 of file ofdm-downlink-frame-prefix.cc.

References AddDlFramePrefixElement(), ns3::DlFramePrefixIe::GetDiuc(), GetSerializedSize(), m_baseStationId, m_configurationChangeCount, m_frameNumber, m_hcs, ns3::DlFramePrefixIe::Read(), ns3::ReadFrom(), ns3::Buffer::Iterator::ReadU32(), and ns3::Buffer::Iterator::ReadU8().

Here is the call graph for this function:

◆ GetBaseStationId()

Mac48Address ns3::OfdmDownlinkFramePrefix::GetBaseStationId ( ) const

Get base station ID field.

Returns: the base station ID

Definition at line 186 of file ofdm-downlink-frame-prefix.cc.

References m_baseStationId.

◆ GetConfigurationChangeCount()

uint8_t ns3::OfdmDownlinkFramePrefix::GetConfigurationChangeCount ( ) const

Get configuration change count field.

Returns: the configuration change count

Definition at line 198 of file ofdm-downlink-frame-prefix.cc.

References m_configurationChangeCount.

◆ GetDlFramePrefixElements()

std::vector< DlFramePrefixIe > ns3::OfdmDownlinkFramePrefix::GetDlFramePrefixElements ( ) const

Get DL frame prefix elements.

Returns: the DL frame prefix elements

Definition at line 204 of file ofdm-downlink-frame-prefix.cc.

References m_dlFramePrefixElements.

◆ GetFrameNumber()

uint32_t ns3::OfdmDownlinkFramePrefix::GetFrameNumber ( ) const

Get frame number field.

Returns: the frame number

Definition at line 192 of file ofdm-downlink-frame-prefix.cc.

References m_frameNumber.

◆ GetHcs()

uint8_t ns3::OfdmDownlinkFramePrefix::GetHcs ( ) const

Get HCS field.

Returns: the HCS

Definition at line 210 of file ofdm-downlink-frame-prefix.cc.

References m_hcs.

◆ GetName()

std::string ns3::OfdmDownlinkFramePrefix::GetName ( ) const

Get name field.

Returns: the name

Definition at line 216 of file ofdm-downlink-frame-prefix.cc.

◆ GetSerializedSize()

uint32_t ns3::OfdmDownlinkFramePrefix::GetSerializedSize ( ) const

overridevirtual

Returns: the expected size of the header.

This method is used by Packet::AddHeader to store a header into the byte buffer of a packet. This method should return the number of bytes which are needed to store the full header data by Serialize.

Implements ns3::Header.

Definition at line 231 of file ofdm-downlink-frame-prefix.cc.

References m_dlFramePrefixElements.

Referenced by Deserialize().

Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::OfdmDownlinkFramePrefix::GetTypeId ( )

static

Register this type.

Returns: The TypeId.

Definition at line 146 of file ofdm-downlink-frame-prefix.cc.

References ns3::TypeId::SetParent().

Here is the call graph for this function:

◆ Print()

void ns3::OfdmDownlinkFramePrefix::Print ( std::ostream & os ) const

overridevirtual

Parameters

os output stream This method is used by Packet::Print to print the content of a header as ascii data to a c++ output stream. Although the header is free to format its output as it wishes, it is recommended to follow a few rules to integrate with the packet pretty printer: start with flags, small field values located between a pair of parens. Values should be separated by whitespace. Follow the parens with the important fields, separated by whitespace. i.e.: (field1 val1 field2 val2 field3 val3) field4 val4 field5 val5

Implements ns3::Header.

Definition at line 222 of file ofdm-downlink-frame-prefix.cc.

References m_baseStationId, m_configurationChangeCount, m_dlFramePrefixElements, m_frameNumber, and m_hcs.

◆ Serialize()

void ns3::OfdmDownlinkFramePrefix::Serialize ( Buffer::Iterator start ) const

overridevirtual

Parameters

start an iterator which points to where the header should be written.

This method is used by Packet::AddHeader to store a header into the byte buffer of a packet. The data written is expected to match bit-for-bit the representation of this header in a real network.

Implements ns3::Header.

Definition at line 244 of file ofdm-downlink-frame-prefix.cc.

References m_baseStationId, m_configurationChangeCount, m_dlFramePrefixElements, m_frameNumber, m_hcs, ns3::Buffer::Iterator::Write(), ns3::WriteTo(), ns3::Buffer::Iterator::WriteU32(), and ns3::Buffer::Iterator::WriteU8().

Here is the call graph for this function: