ns-3
|
Creates DeviceEnergyModel objects. More...
#include <energy-model-helper.h>
Public Member Functions | |
virtual void | Set (std::string name, const AttributeValue &v)=0 |
DeviceEnergyModelContainer | Install (Ptr< NetDevice > device, Ptr< EnergySource > source) const |
DeviceEnergyModelContainer | Install (NetDeviceContainer deviceContainer, EnergySourceContainer sourceContainer) const |
Creates DeviceEnergyModel objects.
This class helps to create and install DeviceEnergyModel onto NetDevice. A DeviceEnergyModel is connected to a NetDevice (or PHY object) by callbacks. Note that DeviceEnergyModel objects are *not* aggregated onto the node. They can be accessed through the EnergySource object, which *is* aggregated onto the node.
DeviceEnergyModelContainer ns3::DeviceEnergyModelHelper::Install | ( | Ptr< NetDevice > | device, |
Ptr< EnergySource > | source | ||
) | const |
device | Pointer to the NetDevice to install DeviceEnergyModel. |
source | The EnergySource the DeviceEnergyModel will be using. |
Installs an DeviceEnergyModel with a specified EnergySource onto a xNetDevice.
References ns3::EnergySource::GetNode(), ns3::NetDevice::GetNode(), and NS_ASSERT.
DeviceEnergyModelContainer ns3::DeviceEnergyModelHelper::Install | ( | NetDeviceContainer | deviceContainer, |
EnergySourceContainer | sourceContainer | ||
) | const |
deviceContainer | List of NetDevices to be install DeviceEnergyModel objects. |
sourceContainer | List of EnergySource the DeviceEnergyModel will be using. |
Installs DeviceEnergyModels with specified EnergySources onto a list of NetDevices.
References ns3::NetDeviceContainer::Begin(), ns3::EnergySourceContainer::Begin(), ns3::NetDeviceContainer::End(), ns3::EnergySourceContainer::GetN(), ns3::NetDeviceContainer::GetN(), and NS_ASSERT.
virtual void ns3::DeviceEnergyModelHelper::Set | ( | std::string | name, |
const AttributeValue & | v | ||
) | [pure virtual] |
name | Name of attribute to set. |
v | Value of the attribute. |
Sets one of the attributes of underlying DeviceEnergyModel.
Implemented in ns3::WifiRadioEnergyModelHelper, and ns3::AcousticModemEnergyModelHelper.