ns3::UanHeaderRcCtsGlobal Class Reference

Cycle broadcast information for. More...

#include <uan-header-rc.h>

Inheritance diagram for ns3::UanHeaderRcCtsGlobal:

Collaboration diagram for ns3::UanHeaderRcCtsGlobal:

List of all members.

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.
void	SetRateNum (uint16_t rate)
void	SetRetryRate (uint16_t rate)
void	SetWindowTime (Time t)
void	SetTxTimeStamp (Time timeStamp)
uint16_t	GetRateNum (void) const
uint16_t	GetRetryRate (void) const
Time	GetWindowTime (void) const
Time	GetTxTimeStamp (void) const
virtual uint32_t	GetSerializedSize (void) const
virtual void	Serialize (Buffer::Iterator start) const
virtual uint32_t	Deserialize (Buffer::Iterator start)
virtual void	Print (std::ostream &os) const
virtual TypeId	GetInstanceTypeId (void) const
Static Public Member Functions
static TypeId	GetTypeId (void)
	This method returns the TypeId associated to ns3::UanHeaderRcCtsGlobal.

---

Detailed Description

Cycle broadcast information for.

---

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:

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

---

Member Function Documentation

uint32_t ns3::UanHeaderRcCtsGlobal::Deserialize

(

Buffer::Iterator

start

)

[virtual]

Parameters:

start

an 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.

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.

References GetTypeId().

uint16_t ns3::UanHeaderRcCtsGlobal::GetRateNum

(

void

)

const

Returns:

Rate # corresponding to data rate of current cycle

uint16_t ns3::UanHeaderRcCtsGlobal::GetRetryRate

(

void

)

const

Returns:

retry rate # of retry rate for current cycle

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.

Time ns3::UanHeaderRcCtsGlobal::GetTxTimeStamp

(

void

)

const

Returns:

Timestamp of CTS transmission

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.

References ns3::TypeId::SetParent().

Referenced by GetInstanceTypeId().

Time ns3::UanHeaderRcCtsGlobal::GetWindowTime

(

void

)

const

Returns:

Time duration after blocking time allowed for RTS transmissions

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.

References ns3::Time::GetSeconds().

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.

References ns3::Time::GetSeconds(), ns3::Buffer::Iterator::WriteU16(), and ns3::Buffer::Iterator::WriteU32().

void ns3::UanHeaderRcCtsGlobal::SetRateNum

(

uint16_t

rate

)

Parameters:

rate	Rate number corresponding to data rate of current cycle

void ns3::UanHeaderRcCtsGlobal::SetRetryRate

(

uint16_t

rate

)

Parameters:

rate	Retry rate number for current cycle

void ns3::UanHeaderRcCtsGlobal::SetTxTimeStamp

(

Time

timeStamp

)

Parameters:

timeStamp

Time of CTS transmission

void ns3::UanHeaderRcCtsGlobal::SetWindowTime

(

Time

t

)

Parameters:

t	Time duration following blocking time to allow RTS transmissions

---

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

• src/uan/model/uan-header-rc.h
• doc/introspected-doxygen.h
• src/uan/model/uan-header-rc.cc