A Discrete-Event Network Simulator
API
ns3::LinearWifiTxCurrentModel Class Reference

a linear model of the Wifi transmit current More...

#include "wifi-tx-current-model.h"

+ Inheritance diagram for ns3::LinearWifiTxCurrentModel:
+ Collaboration diagram for ns3::LinearWifiTxCurrentModel:

Public Member Functions

 LinearWifiTxCurrentModel ()
 
virtual ~LinearWifiTxCurrentModel ()
 
double CalcTxCurrent (double txPowerDbm) const
 
- Public Member Functions inherited from ns3::WifiTxCurrentModel
 WifiTxCurrentModel ()
 
virtual ~WifiTxCurrentModel ()
 
- Public Member Functions inherited from ns3::Object
 Object ()
 Constructor. More...
 
virtual ~Object ()
 Destructor. More...
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together. More...
 
void Dispose (void)
 Dispose of this Object. More...
 
AggregateIterator GetAggregateIterator (void) const
 Get an iterator to the Objects aggregated to this one. More...
 
virtual TypeId GetInstanceTypeId (void) const
 Get the most derived TypeId for this Object. More...
 
template<>
Ptr< ObjectGetObject () const
 Specialization of () for objects of type ns3::Object. More...
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId. More...
 
template<>
Ptr< ObjectGetObject (TypeId tid) const
 Specialization of (TypeId tid) for objects of type ns3::Object. More...
 
template<typename T >
Ptr< T > GetObject (void) const
 Get a pointer to the requested aggregated Object. More...
 
void Initialize (void)
 Invoke DoInitialize on all Objects aggregated to this one. More...
 
bool IsInitialized (void) const
 Check if the object has been initialized. More...
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 Default constructor. More...
 
 SimpleRefCount (const SimpleRefCount &o[[maybe_unused]])
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= ([[maybe_unused]] const SimpleRefCount &o)
 Assignment operator. More...
 
void Ref (void) const
 Increment the reference count. More...
 
void Unref (void) const
 Decrement the reference count. More...
 
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
 Virtual destructor. More...
 
void GetAttribute (std::string name, AttributeValue &value) const
 Get the value of an attribute, raising fatal errors if unsuccessful. More...
 
bool GetAttributeFailSafe (std::string name, AttributeValue &value) const
 Get the value of an attribute without raising erros. More...
 
void SetAttribute (std::string name, const AttributeValue &value)
 Set a single attribute, raising fatal errors if unsuccessful. More...
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 Set a single attribute without raising errors. More...
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 Connect a TraceSource to a Callback with a context. More...
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 Connect a TraceSource to a Callback without a context. More...
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected with a context. More...
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected without a context. More...
 

Static Public Member Functions

static TypeId GetTypeId (void)
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::WifiTxCurrentModel
static TypeId GetTypeId (void)
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId (void)
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 Get the type ID. More...
 

Private Attributes

double m_eta
 ETA. More...
 
double m_idleCurrent
 idle current in Amperes More...
 
double m_voltage
 voltage in Volts More...
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object. More...
 
virtual void DoDispose (void)
 Destructor implementation. More...
 
virtual void DoInitialize (void)
 Initialize() implementation. More...
 
virtual void NotifyNewAggregate (void)
 Notify all Objects aggregated to this one of a new Object being aggregated. More...
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 Complete construction of ObjectBase; invoked by derived classes. More...
 
virtual void NotifyConstructionCompleted (void)
 Notifier called once the ObjectBase is fully constructed. More...
 

Detailed Description

a linear model of the Wifi transmit current

Introspection did not find any typical Config paths.

This model assumes that the transmit current is a linear function of the nominal transmit power used to send the frame. In particular, the power absorbed during the transmission of a frame $ W_{tx} $ is given by the power absorbed by the power amplifier $ W_{pa} $ plus the power absorbed by the RF subsystem. The latter is assumed to be the same as the power absorbed in the IDLE state $ W_{idle} $.

The efficiency $ \eta $ of the power amplifier is given by $ \eta = \frac{P_{tx}}{W_{pa}} $, where $ P_{tx} $ is the output power, i.e., the nominal transmit power. Hence, $ W_{pa} = \frac{P_{tx}}{\eta} $

It turns out that $ W_{tx} = \frac{P_{tx}}{\eta} + W_{idle} $. By dividing both sides by the supply voltage $ V $: $ I_{tx} = \frac{P_{tx}}{V \cdot \eta} + I_{idle} $, where $ I_{tx} $ and $ I_{idle} $ are, respectively, the transmit current and the idle current.

For more information, refer to: Francesco Ivan Di Piazza, Stefano Mangione, and Ilenia Tinnirello. "On the Effects of Transmit Power Control on the Energy Consumption of WiFi Network Cards", Proceedings of ICST QShine 2009, pp. 463–475

If the TX current corresponding to a given nominal transmit power is known, the efficiency of the power amplifier is given by the above formula: $ \eta = \frac{P_{tx}}{(I_{tx}-I_{idle})\cdot V} $


Attributes

  • Eta: The efficiency of the power amplifier.
    • Set with class: ns3::DoubleValue
    • Underlying type: double -1.79769e+308:1.79769e+308
    • Initial value: 0.1
    • Flags: construct write read
  • Voltage: The supply voltage (in Volts).
    • Set with class: ns3::DoubleValue
    • Underlying type: double -1.79769e+308:1.79769e+308
    • Initial value: 3
    • Flags: construct write read
  • IdleCurrent: The current in the IDLE state (in Ampere).
    • Set with class: ns3::DoubleValue
    • Underlying type: double -1.79769e+308:1.79769e+308
    • Initial value: 0.273333
    • Flags: construct write read

No TraceSources are defined for this type.
Size of this type is 56 bytes (on a 64-bit architecture).

Definition at line 84 of file wifi-tx-current-model.h.

Constructor & Destructor Documentation

◆ LinearWifiTxCurrentModel()

ns3::LinearWifiTxCurrentModel::LinearWifiTxCurrentModel ( )

Definition at line 75 of file wifi-tx-current-model.cc.

References NS_LOG_FUNCTION.

◆ ~LinearWifiTxCurrentModel()

ns3::LinearWifiTxCurrentModel::~LinearWifiTxCurrentModel ( )
virtual

Definition at line 80 of file wifi-tx-current-model.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ CalcTxCurrent()

double ns3::LinearWifiTxCurrentModel::CalcTxCurrent ( double  txPowerDbm) const
virtual
Parameters
txPowerDbmthe nominal TX power in dBm
Returns
the transmit current (in Ampere)

Implements ns3::WifiTxCurrentModel.

Definition at line 86 of file wifi-tx-current-model.cc.

References ns3::DbmToW(), m_eta, m_idleCurrent, m_voltage, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

◆ GetTypeId()

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

Get the type ID.

Returns
the object TypeId

Definition at line 53 of file wifi-tx-current-model.cc.

References m_eta, m_idleCurrent, m_voltage, ns3::MakeDoubleAccessor(), and ns3::TypeId::SetParent().

+ Here is the call graph for this function:

Member Data Documentation

◆ m_eta

double ns3::LinearWifiTxCurrentModel::m_eta
private

ETA.

Definition at line 100 of file wifi-tx-current-model.h.

Referenced by CalcTxCurrent(), and GetTypeId().

◆ m_idleCurrent

double ns3::LinearWifiTxCurrentModel::m_idleCurrent
private

idle current in Amperes

Definition at line 102 of file wifi-tx-current-model.h.

Referenced by CalcTxCurrent(), and GetTypeId().

◆ m_voltage

double ns3::LinearWifiTxCurrentModel::m_voltage
private

voltage in Volts

Definition at line 101 of file wifi-tx-current-model.h.

Referenced by CalcTxCurrent(), and GetTypeId().


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