Cycle broadcast information. More...

#include <uan-header-rc.h>

Inheritance diagram for ns3::UanHeaderRcCtsGlobal:

Collaboration diagram for ns3::UanHeaderRcCtsGlobal:

Public Member Functions
	UanHeaderRcCtsGlobal ()
	Default constructor. More...

	UanHeaderRcCtsGlobal (Time wt, Time ts, uint16_t rate, uint16_t retryRate)
	Constructor. More...

	~UanHeaderRcCtsGlobal ()
	Destructor. More...

virtual uint32_t	Deserialize (Buffer::Iterator start)

virtual TypeId	GetInstanceTypeId (void) const

uint16_t	GetRateNum (void) const
	Get the data rate number. More...

uint16_t	GetRetryRate (void) const
	Get the retry rate number. More...

virtual uint32_t	GetSerializedSize (void) const

Time	GetTxTimeStamp (void) const
	Get the CTS transmit timestamp. More...

Time	GetWindowTime (void) const
	Get the window time (time duration following blocking time to allow RTS transmissions). More...

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

virtual void	Serialize (Buffer::Iterator start) const

void	SetRateNum (uint16_t rate)
	Set the rate number corresponding to data rate of current cycle. More...

void	SetRetryRate (uint16_t rate)
	Set the retry rate number for the current cycle. More...

void	SetTxTimeStamp (Time timeStamp)
	Set the CTS timestamp. More...

void	SetWindowTime (Time t)
	Set the window time (time duration following blocking time to allow RTS transmissions). More...

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

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

void	GetAttribute (std::string name, AttributeValue &value) const

bool	GetAttributeFailSafe (std::string name, AttributeValue &attribute) const

void	SetAttribute (std::string name, const AttributeValue &value)

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)

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

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

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

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

Private Attributes
uint16_t	m_rateNum
	Rate number. More...

uint16_t	m_retryRate
	Retry rate. More...

Time	m_timeStampTx
	Timestamp. More...

Time	m_winTime
	Window time. More...

Additional Inherited Members
Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)

virtual void	NotifyConstructionCompleted (void)
	This method is invoked once all member attributes have been initialized. More...

Detailed Description

Cycle broadcast information.

Doxygen introspection did not find any typical Config paths.

This includes the rate number, retry rate and window time.

No Attributes are defined for this type.
No TraceSources are defined for this type.

Definition at line 224 of file uan-header-rc.h.

Constructor & Destructor Documentation

ns3::UanHeaderRcCtsGlobal::UanHeaderRcCtsGlobal ( )

Default constructor.

Definition at line 264 of file uan-header-rc.cc.

ns3::UanHeaderRcCtsGlobal::UanHeaderRcCtsGlobal	(	Time	wt,
		Time	ts,
		uint16_t	rate,
		uint16_t	retryRate
	)

Constructor.

Parameters

wt	Window time.
ts	Timestamp.
rate	Rate number.
retryRate	Retry rate value.

Definition at line 272 of file uan-header-rc.cc.

ns3::UanHeaderRcCtsGlobal::~UanHeaderRcCtsGlobal ( )

Destructor.

Definition at line 282 of file uan-header-rc.cc.

Member Function Documentation

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

virtual

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 362 of file uan-header-rc.cc.

References ns3::Buffer::Iterator::GetDistanceFrom(), m_rateNum, m_retryRate, m_timeStampTx, m_winTime, ns3::Buffer::Iterator::ReadU16(), ns3::Buffer::Iterator::ReadU32(), ns3::Seconds(), and visualizer.core::start().

Here is the call graph for this function:

TypeId ns3::UanHeaderRcCtsGlobal::GetInstanceTypeId ( void ) const

virtual

Returns: the TypeId associated to the most-derived type of this instance.

This method is typically implemented by ns3::Object::GetInstanceTypeId but some classes which derive from ns3::ObjectBase directly have to implement it themselves.

Implements ns3::ObjectBase.

Definition at line 380 of file uan-header-rc.cc.

References GetTypeId().

Here is the call graph for this function:

uint16_t ns3::UanHeaderRcCtsGlobal::GetRateNum ( void ) const

Get the data rate number.

Returns: The rate number.

Definition at line 342 of file uan-header-rc.cc.

References m_rateNum.

Referenced by ns3::UanMacRc::ReceiveOkFromPhy().

Here is the caller graph for this function:

uint16_t ns3::UanHeaderRcCtsGlobal::GetRetryRate ( void ) const

Get the retry rate number.

Returns: The retry rate number.

Definition at line 336 of file uan-header-rc.cc.

References m_retryRate.

Referenced by ns3::UanMacRc::ReceiveOkFromPhy().

Here is the caller graph for this function:

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

virtual

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 347 of file uan-header-rc.cc.

Referenced by ns3::UanMacRc::UanMacRc(), and ns3::UanMacRcGw::UanMacRcGw().

Here is the caller graph for this function:

Time ns3::UanHeaderRcCtsGlobal::GetTxTimeStamp ( void ) const

Get the CTS transmit timestamp.

Returns: The timestamp.

Definition at line 330 of file uan-header-rc.cc.

References m_timeStampTx.

Referenced by ns3::UanMacRc::ScheduleData().

Here is the caller graph for this function:

TypeId ns3::UanHeaderRcCtsGlobal::GetTypeId ( void )

static

Register this type.

Returns: The TypeId.

Definition at line 288 of file uan-header-rc.cc.

References ns3::TypeId::SetParent().

Referenced by GetInstanceTypeId().

Here is the call graph for this function:

Here is the caller graph for this function:

Time ns3::UanHeaderRcCtsGlobal::GetWindowTime ( void ) const

Get the window time (time duration following blocking time to allow RTS transmissions).

Returns: The window time.

Definition at line 324 of file uan-header-rc.cc.

References m_winTime.

Referenced by ns3::UanMacRc::ReceiveOkFromPhy().

Here is the caller graph for this function:

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

virtual

Parameters

os output stream This method is used by Packet::Print to print the content of a trailer as ascii data to a c++ output stream. Although the trailer 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 374 of file uan-header-rc.cc.

References ns3::Time::GetSeconds(), m_rateNum, m_retryRate, m_timeStampTx, and m_winTime.

Here is the call graph for this function:

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

virtual

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 353 of file uan-header-rc.cc.

References ns3::Time::GetSeconds(), m_rateNum, m_retryRate, m_timeStampTx, m_winTime, ns3::Buffer::Iterator::WriteU16(), and ns3::Buffer::Iterator::WriteU32().

Here is the call graph for this function: