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

CTS header. More...

#include <uan-header-rc.h>

+ Inheritance diagram for ns3::UanHeaderRcCts:
+ Collaboration diagram for ns3::UanHeaderRcCts:

Public Member Functions

 UanHeaderRcCts ()
 UanHeaderRcCts (uint8_t frameNo, uint8_t retryNo, Time rtsTs, Time delay, UanAddress addr)
virtual ~UanHeaderRcCts ()
virtual uint32_t Deserialize (Buffer::Iterator start)
UanAddress GetAddress (void) const
Time GetDelayToTx (void) const
uint8_t GetFrameNo (void) const
virtual TypeId GetInstanceTypeId (void) const
uint8_t GetRetryNo (void) const
Time GetRtsTimeStamp (void) const
virtual uint32_t GetSerializedSize (void) const
virtual void Print (std::ostream &os) const
virtual void Serialize (Buffer::Iterator start) const
void SetAddress (UanAddress addr)
void SetDelayToTx (Time delay)
void SetFrameNo (uint8_t frameNo)
void SetRetryNo (uint8_t no)
void SetRtsTimeStamp (Time timeStamp)
- 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::UanHeaderRcCts.

Private Attributes

UanAddress m_address
Time m_delay
uint8_t m_frameNo
uint8_t m_retryNo
Time m_timeStampRts

Additional Inherited Members

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

Detailed Description

CTS header.

Includes RTS RX time, CTS TX time, delay until TX, RTS blocking period, RTS tx period, rate #, and retry rate #

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

Constructor & Destructor Documentation

ns3::UanHeaderRcCts::UanHeaderRcCts ( )

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

ns3::UanHeaderRcCts::UanHeaderRcCts ( uint8_t  frameNo,
uint8_t  retryNo,
Time  rtsTs,
Time  delay,
UanAddress  addr 
)
Parameters
frameNoResrvation frame # being cleared
retryNoRetry # of received RTS packet
rtsTsRX time of RTS packet at gateway
delayDelay until transmission
addrDestination of CTS packet
Note
Times are serialized, with ms precission, into 32 bit fields.

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

ns3::UanHeaderRcCts::~UanHeaderRcCts ( )
virtual

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

Member Function Documentation

uint32_t ns3::UanHeaderRcCts::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 501 of file uan-header-rc.cc.

References ns3::Buffer::Iterator::GetDistanceFrom(), m_address, m_delay, m_frameNo, m_retryNo, m_timeStampRts, ns3::Buffer::Iterator::ReadU32(), ns3::Buffer::Iterator::ReadU8(), ns3::Seconds(), and visualizer.core::start().

+ Here is the call graph for this function:

UanAddress ns3::UanHeaderRcCts::GetAddress ( void  ) const
Returns
Destination for scheduling info

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

References m_address.

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

+ Here is the caller graph for this function:

Time ns3::UanHeaderRcCts::GetDelayToTx ( void  ) const
Returns
Delay from TX time of CTS packet until arrival of first data frame

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

References m_delay.

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

+ Here is the caller graph for this function:

uint8_t ns3::UanHeaderRcCts::GetFrameNo ( void  ) const
Returns
Frame # of RTS being cleared

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

References m_frameNo.

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

+ Here is the caller graph for this function:

TypeId ns3::UanHeaderRcCts::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 520 of file uan-header-rc.cc.

References GetTypeId().

+ Here is the call graph for this function:

uint8_t ns3::UanHeaderRcCts::GetRetryNo ( void  ) const
Returns
Retry # of RTS packet being cleared

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

References m_retryNo.

Time ns3::UanHeaderRcCts::GetRtsTimeStamp ( void  ) const
Returns
RX time of RTS being cleared

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

References m_timeStampRts.

uint32_t ns3::UanHeaderRcCts::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 484 of file uan-header-rc.cc.

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

+ Here is the caller graph for this function:

TypeId ns3::UanHeaderRcCts::GetTypeId ( void  )
static

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

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

Reimplemented from ns3::Header.

Definition at line 413 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:

void ns3::UanHeaderRcCts::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 514 of file uan-header-rc.cc.

References ns3::Time::GetSeconds(), m_address, m_delay, m_frameNo, m_retryNo, and m_timeStampRts.

+ Here is the call graph for this function:

void ns3::UanHeaderRcCts::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 491 of file uan-header-rc.cc.

References ns3::UanAddress::GetAsInt(), ns3::Time::GetSeconds(), m_address, m_delay, m_frameNo, m_retryNo, m_timeStampRts, ns3::Buffer::Iterator::WriteU32(), and ns3::Buffer::Iterator::WriteU8().

+ Here is the call graph for this function:

void ns3::UanHeaderRcCts::SetAddress ( UanAddress  addr)
Parameters
addrDestination for scheduling info

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

References m_address.

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

+ Here is the caller graph for this function:

void ns3::UanHeaderRcCts::SetDelayToTx ( Time  delay)
Parameters
delayTime duration, from CTS TX, before first data frame arrival

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

References m_delay.

void ns3::UanHeaderRcCts::SetFrameNo ( uint8_t  frameNo)
Parameters
frameNoFrame # of RTS being cleared

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

References m_frameNo.

void ns3::UanHeaderRcCts::SetRetryNo ( uint8_t  no)
Parameters
noRetry number of RTS frame being cleared

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

References m_retryNo.

void ns3::UanHeaderRcCts::SetRtsTimeStamp ( Time  timeStamp)
Parameters
timeStampTime of RTS reception

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

References m_timeStampRts.

Member Data Documentation

UanAddress ns3::UanHeaderRcCts::m_address
private

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

Referenced by Deserialize(), GetAddress(), Print(), Serialize(), and SetAddress().

Time ns3::UanHeaderRcCts::m_delay
private

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

Referenced by Deserialize(), GetDelayToTx(), Print(), Serialize(), and SetDelayToTx().

uint8_t ns3::UanHeaderRcCts::m_frameNo
private

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

Referenced by Deserialize(), GetFrameNo(), Print(), Serialize(), and SetFrameNo().

uint8_t ns3::UanHeaderRcCts::m_retryNo
private

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

Referenced by Deserialize(), GetRetryNo(), Print(), Serialize(), and SetRetryNo().

Time ns3::UanHeaderRcCts::m_timeStampRts
private

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

Referenced by Deserialize(), GetRtsTimeStamp(), Print(), Serialize(), and SetRtsTimeStamp().


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