ns3::BasicEnergySourceHelper Class Reference

Creates a BasicEnergySource object. More...

#include <basic-energy-source-helper.h>

Inheritance diagram for ns3::BasicEnergySourceHelper:

Collaboration diagram for ns3::BasicEnergySourceHelper:

Public Member Functions
	BasicEnergySourceHelper ()
	~BasicEnergySourceHelper ()
void	Set (std::string name, const AttributeValue &v)
Public Member Functions inherited from ns3::EnergySourceHelper
virtual	~EnergySourceHelper ()
EnergySourceContainer	Install (Ptr< Node > node) const
EnergySourceContainer	Install (NodeContainer c) const
EnergySourceContainer	Install (std::string nodeName) const
EnergySourceContainer	InstallAll (void) const
	This function installs an EnergySource on all nodes in simulation.

Private Member Functions
virtual Ptr< EnergySource >	DoInstall (Ptr< Node > node) const

Private Attributes
ObjectFactory	m_basicEnergySource

Detailed Description

Creates a BasicEnergySource object.

Definition at line 34 of file basic-energy-source-helper.h.

Constructor & Destructor Documentation

ns3::BasicEnergySourceHelper::BasicEnergySourceHelper

(

)

Definition at line 26 of file basic-energy-source-helper.cc.

References m_basicEnergySource, and ns3::ObjectFactory::SetTypeId().

Here is the call graph for this function:

ns3::BasicEnergySourceHelper::~BasicEnergySourceHelper

(

)

Definition at line 31 of file basic-energy-source-helper.cc.

Member Function Documentation

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

privatevirtual

Definition at line 42 of file basic-energy-source-helper.cc.

References ns3::ObjectFactory::Create(), ns3::Object::GetObject(), m_basicEnergySource, NS_ASSERT, NS_FATAL_ERROR, and ns3::EnergySource::SetNode().

Here is the call graph for this function:

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

virtual

Parameters

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

Sets one of the attributes of underlying EnergySource.

Implements ns3::EnergySourceHelper.

Definition at line 36 of file basic-energy-source-helper.cc.

References m_basicEnergySource, and ns3::ObjectFactory::Set().

Referenced by BasicEnergyDepletionTest::DepletionTestCase(), ns3::AcousticModemEnergyTestCase::DoRun(), and ns3::AcousticModemEnergyDepletionTestCase::DoRun().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

ObjectFactory ns3::BasicEnergySourceHelper::m_basicEnergySource

private

Definition at line 46 of file basic-energy-source-helper.h.

Referenced by BasicEnergySourceHelper(), DoInstall(), and Set().

---

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

• src/energy/helper/basic-energy-source-helper.h
• src/energy/helper/basic-energy-source-helper.cc