A Discrete-Event Network Simulator
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
ns3::BasicEnergySourceHelper Class Reference

Creates a BasicEnergySource object. More...

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

+ Inheritance diagram for ns3::BasicEnergySourceHelper:

Public Member Functions

void Set (std::string name, const AttributeValue &v)
- Public Member Functions inherited from ns3::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. More...

Private Member Functions

virtual Ptr< EnergySourceDoInstall (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.

Member Function Documentation

Ptr< EnergySource > ns3::BasicEnergySourceHelper::DoInstall ( Ptr< Node node) const
nodePointer to node where the energy source is to be installed.
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 42 of file basic-energy-source-helper.cc.

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

void ns3::BasicEnergySourceHelper::Set ( std::string  name,
const AttributeValue v 
nameName of attribute to set.
vValue 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 ns3::ObjectFactory::Set().

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

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