A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
ns3::UanHeaderRcCtsGlobal Class Reference

Cycle broadcast information for. More...

#include <uan-header-rc.h>

+ Inheritance diagram for ns3::UanHeaderRcCtsGlobal:
+ Collaboration diagram for ns3::UanHeaderRcCtsGlobal:

Public Member Functions

 UanHeaderRcCtsGlobal ()
 Create UanHeaderRcCtsGlobal with fields zeroed out.
 UanHeaderRcCtsGlobal (Time wt, Time ts, uint16_t rate, uint16_t retryRate)
 Create object with given window time, time stamp, rate, and retry rate.
 ~UanHeaderRcCtsGlobal ()
virtual uint32_t Deserialize (Buffer::Iterator start)
virtual TypeId GetInstanceTypeId (void) const
uint16_t GetRateNum (void) const
uint16_t GetRetryRate (void) const
virtual uint32_t GetSerializedSize (void) const
Time GetTxTimeStamp (void) const
Time GetWindowTime (void) const
virtual void Print (std::ostream &os) const
virtual void Serialize (Buffer::Iterator start) const
void SetRateNum (uint16_t rate)
void SetRetryRate (uint16_t rate)
void SetTxTimeStamp (Time timeStamp)
void SetWindowTime (Time t)
- Public Member Functions inherited from ns3::Header
virtual ~Header ()

Static Public Member Functions

static TypeId GetTypeId (void)
 This method returns the TypeId associated to ns3::UanHeaderRcCtsGlobal.

Private Attributes

uint16_t m_rateNum
uint16_t m_retryRate
Time m_timeStampTx
Time m_winTime

Additional Inherited Members

- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
virtual void NotifyConstructionCompleted (void)

Detailed Description

Cycle broadcast information for.

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

Constructor & Destructor Documentation

ns3::UanHeaderRcCtsGlobal::UanHeaderRcCtsGlobal ( )

Create UanHeaderRcCtsGlobal with fields zeroed out.

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

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

Create object with given window time, time stamp, rate, and retry rate.

Parameters
wtWindow time
tsTimestamp
rateRate number
retryRateRetry rate value

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

ns3::UanHeaderRcCtsGlobal::~UanHeaderRcCtsGlobal ( )

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

Member Function Documentation

uint32_t ns3::UanHeaderRcCtsGlobal::Deserialize ( Buffer::Iterator  start)
virtual
Parameters
startan iterator which points to where the header should written.
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.

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
Returns
Rate # corresponding to data rate of current cycle

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
Returns
retry rate # of retry rate for current cycle

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
Returns
Timestamp of CTS transmission

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

This method returns the TypeId associated to ns3::UanHeaderRcCtsGlobal.

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

Reimplemented from ns3::Header.

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
Returns
Time duration after blocking time allowed for RTS transmissions

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
osoutput 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
startan 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:

void ns3::UanHeaderRcCtsGlobal::SetRateNum ( uint16_t  rate)
Parameters
rateRate number corresponding to data rate of current cycle

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

References m_rateNum.

Referenced by ns3::UanMacRcGw::StartCycle().

+ Here is the caller graph for this function:

void ns3::UanHeaderRcCtsGlobal::SetRetryRate ( uint16_t  rate)
Parameters
rateRetry rate number for current cycle

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

References m_retryRate.

Referenced by ns3::UanMacRcGw::StartCycle().

+ Here is the caller graph for this function:

void ns3::UanHeaderRcCtsGlobal::SetTxTimeStamp ( Time  timeStamp)
Parameters
timeStampTime of CTS transmission

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

References m_timeStampTx.

Referenced by ns3::UanMacRcGw::StartCycle().

+ Here is the caller graph for this function:

void ns3::UanHeaderRcCtsGlobal::SetWindowTime ( Time  t)
Parameters
tTime duration following blocking time to allow RTS transmissions

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

References m_winTime.

Referenced by ns3::UanMacRcGw::StartCycle().

+ Here is the caller graph for this function:

Member Data Documentation

uint16_t ns3::UanHeaderRcCtsGlobal::m_rateNum
private

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

Referenced by Deserialize(), GetRateNum(), Print(), Serialize(), and SetRateNum().

uint16_t ns3::UanHeaderRcCtsGlobal::m_retryRate
private

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

Referenced by Deserialize(), GetRetryRate(), Print(), Serialize(), and SetRetryRate().

Time ns3::UanHeaderRcCtsGlobal::m_timeStampTx
private

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

Referenced by Deserialize(), GetTxTimeStamp(), Print(), Serialize(), and SetTxTimeStamp().

Time ns3::UanHeaderRcCtsGlobal::m_winTime
private

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

Referenced by Deserialize(), GetWindowTime(), Print(), Serialize(), and SetWindowTime().


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