#include <energy-model-helper.h>

Inheritance diagram for ns3::DeviceEnergyModelHelper:

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

Detailed Description

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.

Member Function Documentation

DeviceEnergyModelContainer ns3::DeviceEnergyModelHelper::Install	(	Ptr< NetDevice >	device,
		Ptr< EnergySource >	source
	)			const

Parameters:

	device	Pointer to the NetDevice to install DeviceEnergyModel.
	source	The EnergySource the DeviceEnergyModel will be using.

Returns:: An DeviceEnergyModelContainer contains all the DeviceEnergyModels.

Installs an DeviceEnergyModel with a specified EnergySource onto a xNetDevice.

DeviceEnergyModelContainer ns3::DeviceEnergyModelHelper::Install	(	NetDeviceContainer	deviceContainer,
		EnergySourceContainer	sourceContainer
	)			const

Parameters:

	deviceContainer	List of NetDevices to be install DeviceEnergyModel objects.
	sourceContainer	List of EnergySource the DeviceEnergyModel will be using.

Returns:: An DeviceEnergyModelContainer contains all the DeviceEnergyModels.

Installs DeviceEnergyModels with specified EnergySources onto a list of NetDevices.

virtual void ns3::DeviceEnergyModelHelper::Set	(	std::string	name,
		const AttributeValue &	v
	)			`[pure virtual]`

Parameters:

	name	Name of attribute to set.
	v	Value of the attribute.

Sets one of the attributes of underlying DeviceEnergyModel.

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