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

Doxygen introspection did not find any typical Config paths. More...

#include <lr-wpan-lqi-tag.h>

+ Inheritance diagram for ns3::LrWpanLqiTag:
+ Collaboration diagram for ns3::LrWpanLqiTag:

Public Member Functions

 LrWpanLqiTag (void)
 Create a LrWpanLqiTag with the default LQI 0. More...
 
 LrWpanLqiTag (uint8_t lqi)
 Create a LrWpanLqiTag with the given LQI value. More...
 
virtual void Deserialize (TagBuffer i)
 
uint8_t Get (void) const
 Get the LQI value. More...
 
virtual TypeId GetInstanceTypeId (void) const
 
virtual uint32_t GetSerializedSize (void) const
 
virtual void Print (std::ostream &os) const
 
virtual void Serialize (TagBuffer i) const
 
void Set (uint8_t lqi)
 Set the LQI to the given value. More...
 
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
 Virtual destructor. More...
 
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)
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::Tag
static TypeId GetTypeId (void)
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 Get the type ID. More...
 

Private Attributes

uint8_t m_lqi
 The current LQI value of the tag. More...
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 
virtual void NotifyConstructionCompleted (void)
 This method is invoked once all member attributes have been initialized. More...
 

Detailed Description

Doxygen introspection did not find any typical Config paths.


Attributes

No TraceSources are defined for this type.

Definition at line 28 of file lr-wpan-lqi-tag.h.

Constructor & Destructor Documentation

ns3::LrWpanLqiTag::LrWpanLqiTag ( void  )

Create a LrWpanLqiTag with the default LQI 0.

Definition at line 48 of file lr-wpan-lqi-tag.cc.

ns3::LrWpanLqiTag::LrWpanLqiTag ( uint8_t  lqi)

Create a LrWpanLqiTag with the given LQI value.

Definition at line 53 of file lr-wpan-lqi-tag.cc.

Member Function Documentation

void ns3::LrWpanLqiTag::Deserialize ( TagBuffer  i)
virtual
Parameters
ithe buffer to read data from.

Read the content of the tag from the provided tag buffer. DO NOT attempt to read more bytes than you wrote with Tag::Serialize.

Implements ns3::Tag.

Definition at line 71 of file lr-wpan-lqi-tag.cc.

References m_lqi, and ns3::TagBuffer::ReadU8().

+ Here is the call graph for this function:

uint8_t ns3::LrWpanLqiTag::Get ( void  ) const

Get the LQI value.

Returns
the LQI value

Definition at line 89 of file lr-wpan-lqi-tag.cc.

References m_lqi.

Referenced by ns3::LrWpanPhy::CheckInterference(), ns3::LrWpanPhy::EndRx(), and GetTypeId().

+ Here is the caller graph for this function:

TypeId ns3::LrWpanLqiTag::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 43 of file lr-wpan-lqi-tag.cc.

References GetTypeId().

+ Here is the call graph for this function:

uint32_t ns3::LrWpanLqiTag::GetSerializedSize ( void  ) const
virtual
Returns
the number of bytes required to serialize the data of the tag.

This method is typically invoked by Packet::AddPacketTag or Packet::AddByteTag just prior to calling Tag::Serialize.

Implements ns3::Tag.

Definition at line 59 of file lr-wpan-lqi-tag.cc.

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

Get the type ID.

Returns
the object TypeId

Definition at line 29 of file lr-wpan-lqi-tag.cc.

References Get(), and ns3::TypeId::SetParent().

Referenced by GetInstanceTypeId().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::LrWpanLqiTag::Print ( std::ostream &  os) const
virtual
Parameters
osthe stream to print to

This method is typically invoked from the Packet::PrintByteTags or Packet::PrintPacketTags methods.

Implements ns3::Tag.

Definition at line 77 of file lr-wpan-lqi-tag.cc.

References m_lqi.

void ns3::LrWpanLqiTag::Serialize ( TagBuffer  i) const
virtual
Parameters
ithe buffer to write data into.

Write the content of the tag in the provided tag buffer. DO NOT attempt to write more bytes than you requested with Tag::GetSerializedSize.

Implements ns3::Tag.

Definition at line 65 of file lr-wpan-lqi-tag.cc.

References m_lqi, and ns3::TagBuffer::WriteU8().

+ Here is the call graph for this function:

void ns3::LrWpanLqiTag::Set ( uint8_t  lqi)

Set the LQI to the given value.

Parameters
lqithe value of the LQI to set

Definition at line 83 of file lr-wpan-lqi-tag.cc.

References m_lqi.

Referenced by ns3::LrWpanPhy::CheckInterference().

+ Here is the caller graph for this function:

Member Data Documentation

uint8_t ns3::LrWpanLqiTag::m_lqi
private

The current LQI value of the tag.

Definition at line 72 of file lr-wpan-lqi-tag.h.

Referenced by Deserialize(), Get(), Print(), Serialize(), and Set().


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