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

#include <introspected-doxygen.h>

+ Inheritance diagram for ns3::UanHeaderCommon:

Public Member Functions

 UanHeaderCommon (const UanAddress src, const UanAddress dest, uint8_t type)
 Create UanHeaderCommon object with given source and destination address and header type. More...
 
virtual uint32_t Deserialize (Buffer::Iterator start)
 
UanAddress GetDest (void) const
 
virtual TypeId GetInstanceTypeId (void) const
 
virtual uint32_t GetSerializedSize (void) const
 
UanAddress GetSrc (void) const
 
uint8_t GetType (void) const
 
virtual void Print (std::ostream &os) const
 
virtual void Serialize (Buffer::Iterator start) const
 
void SetDest (UanAddress dest)
 
void SetSrc (UanAddress src)
 
void SetType (uint8_t type)
 
- 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

UanAddress m_dest
 
UanAddress m_src
 
uint8_t m_type
 

Additional Inherited Members

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

Detailed Description

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

Header includes 1 byte src address, 1 byte dest address, and a 1 byte type field.

Definition at line 37 of file uan-header-common.h.

Constructor & Destructor Documentation

ns3::UanHeaderCommon::UanHeaderCommon ( const UanAddress  src,
const UanAddress  dest,
uint8_t  type 
)

Create UanHeaderCommon object with given source and destination address and header type.

Parameters
srcSource address defined in header
destDestination address defined in header
typeHeader type

Definition at line 32 of file uan-header-common.cc.

Member Function Documentation

uint32_t ns3::UanHeaderCommon::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 111 of file uan-header-common.cc.

References ns3::Buffer::Iterator::GetDistanceFrom(), and ns3::Buffer::Iterator::ReadU8().

UanAddress ns3::UanHeaderCommon::GetDest ( void  ) const
Returns
UanAddress in destination field

Definition at line 79 of file uan-header-common.cc.

Referenced by ns3::UanMacAloha::RxPacketGood().

TypeId ns3::UanHeaderCommon::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 52 of file uan-header-common.cc.

uint32_t ns3::UanHeaderCommon::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 97 of file uan-header-common.cc.

Referenced by ns3::AcousticModemEnergyTestCase::DoRun(), and ns3::Reservation::Reservation().

UanAddress ns3::UanHeaderCommon::GetSrc ( void  ) const
Returns
UanAddress in source field

Definition at line 84 of file uan-header-common.cc.

Referenced by ns3::UanPhyCalcSinrDual::CalcSinrDb(), and ns3::UanMacAloha::RxPacketGood().

uint8_t ns3::UanHeaderCommon::GetType ( void  ) const
Returns
value of type field

Definition at line 89 of file uan-header-common.cc.

Referenced by ns3::UanPhyCalcSinrDual::CalcSinrDb().

void ns3::UanHeaderCommon::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 123 of file uan-header-common.cc.

void ns3::UanHeaderCommon::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 103 of file uan-header-common.cc.

References ns3::UanAddress::GetAsInt(), and ns3::Buffer::Iterator::WriteU8().

void ns3::UanHeaderCommon::SetDest ( UanAddress  dest)
Parameters
destAddress of destination node

Definition at line 62 of file uan-header-common.cc.

Referenced by ns3::UanMacAloha::Enqueue(), and ns3::UanMacCw::Enqueue().

void ns3::UanHeaderCommon::SetSrc ( UanAddress  src)
Parameters
srcAddress of packet source node

Definition at line 67 of file uan-header-common.cc.

Referenced by ns3::UanMacAloha::Enqueue(), and ns3::UanMacCw::Enqueue().

void ns3::UanHeaderCommon::SetType ( uint8_t  type)
Parameters
typeValue to set 1 byte type field to. Value has protocol specific meaning

Definition at line 73 of file uan-header-common.cc.

Referenced by ns3::UanMacAloha::Enqueue(), and ns3::UanMacCw::Enqueue().


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