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

Extra data header information. More...

#include <uan-header-rc.h>

+ Inheritance diagram for ns3::UanHeaderRcData:
+ Collaboration diagram for ns3::UanHeaderRcData:

Public Member Functions

 UanHeaderRcData ()
 UanHeaderRcData (uint8_t frameNum, Time propDelay)
virtual ~UanHeaderRcData ()
virtual uint32_t Deserialize (Buffer::Iterator start)
uint8_t GetFrameNo (void) const
virtual TypeId GetInstanceTypeId (void) const
Time GetPropDelay (void) const
virtual uint32_t GetSerializedSize (void) const
virtual void Print (std::ostream &os) const
virtual void Serialize (Buffer::Iterator start) const
void SetFrameNo (uint8_t frameNum)
void SetPropDelay (Time propDelay)
- Public Member Functions inherited from ns3::Header
virtual ~Header ()

Static Public Member Functions

static TypeId GetTypeId (void)

Private Attributes

uint8_t m_frameNo
Time m_propDelay

Additional Inherited Members

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

Detailed Description

Extra data header information.

This type is not accessible from the Config system.
No Attributes are defined for this type.
No TraceSources are defined for this type.

Adds prop. delay measure, and frame number info to transmitted data packet

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

Constructor & Destructor Documentation

ns3::UanHeaderRcData::UanHeaderRcData ( )

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

ns3::UanHeaderRcData::UanHeaderRcData ( uint8_t  frameNum,
Time  propDelay 
)
Parameters
frameNumData frame # of reservation being transmitted
propDelayMeasured propagation delay found in handshaking
Note
Prop. delay is transmitted with 16 bits and ms accuracy

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

ns3::UanHeaderRcData::~UanHeaderRcData ( )
virtual

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

Member Function Documentation

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

References ns3::Buffer::Iterator::GetDistanceFrom(), m_frameNo, m_propDelay, ns3::Buffer::Iterator::ReadU16(), ns3::Buffer::Iterator::ReadU8(), ns3::Seconds(), and visualizer.core::start().

+ Here is the call graph for this function:

uint8_t ns3::UanHeaderRcData::GetFrameNo ( void  ) const
Returns
Data frame # of reservation being transmitted

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

References m_frameNo.

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

+ Here is the caller graph for this function:

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

References GetTypeId().

+ Here is the call graph for this function:

Time ns3::UanHeaderRcData::GetPropDelay ( void  ) const
Returns
Measured propagation delay found in handshaking
Note
Prop. delay is transmitted with 16 bits and ms accuracy

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

References m_propDelay.

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

+ Here is the caller graph for this function:

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

Referenced by ns3::Reservation::Reservation().

+ Here is the caller graph for this function:

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

Reimplemented from ns3::Header.

Definition at line 54 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::UanHeaderRcData::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 111 of file uan-header-rc.cc.

References ns3::Time::GetSeconds(), m_frameNo, and m_propDelay.

+ Here is the call graph for this function:

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

References ns3::Time::GetSeconds(), m_frameNo, m_propDelay, ns3::Buffer::Iterator::WriteU16(), and ns3::Buffer::Iterator::WriteU8().

+ Here is the call graph for this function:

void ns3::UanHeaderRcData::SetFrameNo ( uint8_t  frameNum)
Parameters
frameNumData frame # of reservation being transmitted

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

References m_frameNo.

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

+ Here is the caller graph for this function:

void ns3::UanHeaderRcData::SetPropDelay ( Time  propDelay)
Parameters
propDelayMeasured propagation delay found in handshaking
Note
Prop. delay is transmitted with 16 bits and ms accuracy

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

References m_propDelay.

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

+ Here is the caller graph for this function:

Member Data Documentation

uint8_t ns3::UanHeaderRcData::m_frameNo
private

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

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

Time ns3::UanHeaderRcData::m_propDelay
private

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

Referenced by Deserialize(), GetPropDelay(), Print(), Serialize(), and SetPropDelay().


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