Represent the LQI (Link Quality Estination). More...

#include "lr-wpan-lqi-tag.h"

Inheritance diagram for ns3::lrwpan::LrWpanLqiTag:

Collaboration diagram for ns3::lrwpan::LrWpanLqiTag:

Public Member Functions
	LrWpanLqiTag ()
	Create a LrWpanLqiTag with the default LQI 0.

	LrWpanLqiTag (uint8_t lqi)
	Create a LrWpanLqiTag with the given LQI value.

void	Deserialize (TagBuffer i) override

uint8_t	Get () const
	Get the LQI value.

TypeId	GetInstanceTypeId () const override
	Get the most derived TypeId for this Object.

uint32_t	GetSerializedSize () const override

void	Print (std::ostream &os) const override

void	Serialize (TagBuffer i) const override

void	Set (uint8_t lqi)
	Set the LQI to the given value.

Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
	Virtual destructor.

void	GetAttribute (std::string name, AttributeValue &value, bool permissive=false) const
	Get the value of an attribute, raising fatal errors if unsuccessful.

bool	GetAttributeFailSafe (std::string name, AttributeValue &value) const
	Get the value of an attribute without raising errors.

void	SetAttribute (std::string name, const AttributeValue &value)
	Set a single attribute, raising fatal errors if unsuccessful.

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)
	Set a single attribute without raising errors.

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)
	Connect a TraceSource to a Callback with a context.

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
	Connect a TraceSource to a Callback without a context.

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected with a context.

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected without a context.

Static Public Member Functions
static TypeId	GetTypeId ()
	Get the type ID.

Static Public Member Functions inherited from ns3::Tag
static TypeId	GetTypeId ()
	Get the type ID.

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId ()
	Get the type ID.

Private Attributes
uint8_t	m_lqi
	The current LQI value of the tag.

Additional Inherited Members
Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)
	Complete construction of ObjectBase; invoked by derived classes.

virtual void	NotifyConstructionCompleted ()
	Notifier called once the ObjectBase is fully constructed.

Related Symbols inherited from ns3::ObjectBase
static TypeId	GetObjectIid ()
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly.

Detailed Description

Represent the LQI (Link Quality Estination).

Introspection did not find any typical Config paths.

The LQI Tag is added to each received packet, and can be used by upper layers to estimate the channel conditions.

The LQI is the total packet success rate scaled to 0-255.

Attributes

Lqi: The lqi of the last packet received
- Set with class: ns3::IntegerValue
- Underlying type: uint8_t 0:255
- Flags: read
- Support level: SUPPORTED

No TraceSources are defined for this type.
Group: LrWpan

Size of this type is 16 bytes (on a 64-bit architecture).

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

Constructor & Destructor Documentation

◆ LrWpanLqiTag() [1/2]

ns3::lrwpan::LrWpanLqiTag::LrWpanLqiTag ( )

Create a LrWpanLqiTag with the default LQI 0.

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

◆ LrWpanLqiTag() [2/2]

ns3::lrwpan::LrWpanLqiTag::LrWpanLqiTag ( uint8_t lqi )

Create a LrWpanLqiTag with the given LQI value.

Parameters

lqi The LQI.

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

Member Function Documentation

◆ Deserialize()

void ns3::lrwpan::LrWpanLqiTag::Deserialize ( TagBuffer i )

overridevirtual

Parameters

i	the 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 65 of file lr-wpan-lqi-tag.cc.

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

Here is the call graph for this function:

◆ Get()

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

Get the LQI value.

Returns: the LQI value

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

References m_lqi.

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

Here is the caller graph for this function:

◆ GetInstanceTypeId()

TypeId ns3::lrwpan::LrWpanLqiTag::GetInstanceTypeId ( ) const

overridevirtual

Get the most derived TypeId for this Object.

This method is typically implemented by ns3::Object::GetInstanceTypeId but some classes which derive from ns3::ObjectBase directly have to implement it themselves.

Returns: The TypeId associated to the most-derived type of this instance.

Implements ns3::ObjectBase.

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

References GetTypeId().

Here is the call graph for this function:

◆ GetSerializedSize()

uint32_t ns3::lrwpan::LrWpanLqiTag::GetSerializedSize ( ) const

overridevirtual

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 53 of file lr-wpan-lqi-tag.cc.

◆ GetTypeId()

TypeId ns3::lrwpan::LrWpanLqiTag::GetTypeId ( )

static

Get the type ID.

Returns: the object TypeId

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

References ns3::TypeId::AddDeprecatedName(), Get(), ns3::MakeIntegerAccessor(), ns3::MakeIntegerChecker(), and ns3::TypeId::SetParent().

Referenced by GetInstanceTypeId().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Print()

void ns3::lrwpan::LrWpanLqiTag::Print ( std::ostream & os ) const

overridevirtual

Parameters

os	the stream to print to

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

Implements ns3::Tag.

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

References m_lqi.

◆ Serialize()

void ns3::lrwpan::LrWpanLqiTag::Serialize ( TagBuffer i ) const

overridevirtual

Parameters

i	the 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 59 of file lr-wpan-lqi-tag.cc.

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

Here is the call graph for this function:

◆ Set()

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

Set the LQI to the given value.

Parameters

lqi	the value of the LQI to set

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

References m_lqi.

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

Here is the caller graph for this function:

Member Data Documentation

◆ m_lqi

uint8_t ns3::lrwpan::LrWpanLqiTag::m_lqi

private

The current LQI value of the tag.

Definition at line 74 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:

src/lr-wpan/model/lr-wpan-lqi-tag.h
src/lr-wpan/model/lr-wpan-lqi-tag.cc

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Attributes

Constructor & Destructor Documentation

◆ LrWpanLqiTag() [1/2]

◆ LrWpanLqiTag() [2/2]

Member Function Documentation

◆ Deserialize()

◆ Get()

◆ GetInstanceTypeId()

◆ GetSerializedSize()

◆ GetTypeId()

◆ Print()

◆ Serialize()

◆ Set()

Member Data Documentation

◆ m_lqi