Creates a LiIonEnergySource object. More...

#include "li-ion-energy-source-helper.h"

Inheritance diagram for ns3::LiIonEnergySourceHelper:

Collaboration diagram for ns3::LiIonEnergySourceHelper:

Public Member Functions
	LiIonEnergySourceHelper ()

	~LiIonEnergySourceHelper () override

void	Set (std::string name, const AttributeValue &v) override

Public Member Functions inherited from ns3::EnergySourceHelper
virtual	~EnergySourceHelper ()

energy::EnergySourceContainer	Install (NodeContainer c) const

energy::EnergySourceContainer	Install (Ptr< Node > node) const

energy::EnergySourceContainer	Install (std::string nodeName) const

energy::EnergySourceContainer	InstallAll () const
	This function installs an EnergySource on all nodes in simulation.

Private Member Functions
Ptr< energy::EnergySource >	DoInstall (Ptr< Node > node) const override

Private Attributes
ObjectFactory	m_liIonEnergySource
	LiIon Battery factory.

Detailed Description

Creates a LiIonEnergySource object.

Definition at line 26 of file li-ion-energy-source-helper.h.

Constructor & Destructor Documentation

◆ LiIonEnergySourceHelper()

ns3::LiIonEnergySourceHelper::LiIonEnergySourceHelper ( )

Definition at line 18 of file li-ion-energy-source-helper.cc.

References m_liIonEnergySource.

◆ ~LiIonEnergySourceHelper()

ns3::LiIonEnergySourceHelper::~LiIonEnergySourceHelper ( )

override

Definition at line 23 of file li-ion-energy-source-helper.cc.

Member Function Documentation

◆ DoInstall()

Ptr< energy::EnergySource > ns3::LiIonEnergySourceHelper::DoInstall ( Ptr< Node > node ) const

overrideprivatevirtual

Parameters

node	Pointer to node where the energy source is to be installed.

Returns: Pointer to the created EnergySource.

Child classes of EnergySourceHelper only have to implement this function, to create and aggregate an EnergySource object onto a single node. Rest of the installation process (eg. installing EnergySource on set of nodes) is implemented in the EnergySourceHelper base class.

Implements ns3::EnergySourceHelper.

Definition at line 34 of file li-ion-energy-source-helper.cc.

References m_liIonEnergySource, and NS_ASSERT.