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

Cycle broadcast information for. More...

#include <introspected-doxygen.h>

+ Inheritance 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. More...
 
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::ObjectBase
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)
 
- Static Public Member Functions inherited from ns3::Header
static TypeId GetTypeId (void)
 
- Static Public Member Functions inherited from ns3::Chunk
static TypeId GetTypeId (void)
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 

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.

Doxygen introspection did not find any typical Config paths.
No Attributes are defined for this type.
No TraceSources are defined for this type.

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

Constructor & Destructor Documentation

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.

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(), ns3::Buffer::Iterator::ReadU16(), ns3::Buffer::Iterator::ReadU32(), and ns3::Seconds().

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.

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.

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.

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.

Time ns3::UanHeaderRcCtsGlobal::GetTxTimeStamp ( void  ) const
Returns
Timestamp of CTS transmission

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

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.

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().

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(), ns3::Buffer::Iterator::WriteU16(), and ns3::Buffer::Iterator::WriteU32().

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.

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

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

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

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

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.


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