Creates EnergyHarvester objects. More...
#include "energy-harvester-helper.h"
Public Member Functions | |
virtual | ~EnergyHarvesterHelper () |
energy::EnergyHarvesterContainer | Install (energy::EnergySourceContainer sourceContainer) const |
energy::EnergyHarvesterContainer | Install (Ptr< energy::EnergySource > source) const |
energy::EnergyHarvesterContainer | Install (std::string sourceName) const |
virtual void | Set (std::string name, const AttributeValue &v)=0 |
Private Member Functions | |
virtual Ptr< energy::EnergyHarvester > | DoInstall (Ptr< energy::EnergySource > source) const =0 |
Creates EnergyHarvester objects.
This class creates and installs energy harvesters onto network nodes.
Definition at line 33 of file energy-harvester-helper.h.
|
virtual |
Definition at line 21 of file energy-harvester-helper.cc.
|
privatepure virtual |
source | Pointer to node where the energy harvester is to be installed. |
Child classes of EnergyHarvesterHelper only have to implement this function, to create and aggregate an EnergyHarvester object onto a single node. Rest of the installation process (eg. installing EnergyHarvester on set of nodes) is implemented in the EnergyHarvesterHelper base class.
Implemented in ns3::BasicEnergyHarvesterHelper.
Referenced by Install().
energy::EnergyHarvesterContainer ns3::EnergyHarvesterHelper::Install | ( | energy::EnergySourceContainer | sourceContainer | ) | const |
sourceContainer | List of nodes where EnergyHarvester will be installed. |
This function installs an EnergyHarvester onto a list of energy sources.
Definition at line 32 of file energy-harvester-helper.cc.
References ns3::energy::EnergySourceContainer::Begin(), ns3::ObjectFactory::Create(), DoInstall(), ns3::energy::EnergySourceContainer::End(), and ns3::ObjectFactory::SetTypeId().
energy::EnergyHarvesterContainer ns3::EnergyHarvesterHelper::Install | ( | Ptr< energy::EnergySource > | source | ) | const |
source | Pointer to the energy source where EnergyHarvester will be installed. |
This function installs an EnergyHarvester onto an energy source.
Definition at line 26 of file energy-harvester-helper.cc.
References Install().
Referenced by Install(), and Install().
energy::EnergyHarvesterContainer ns3::EnergyHarvesterHelper::Install | ( | std::string | sourceName | ) | const |
sourceName | Name of node where EnergyHarvester will be installed. |
This function installs an EnergyHarvester onto a node.
Definition at line 63 of file energy-harvester-helper.cc.
References ns3::Names::Find(), and Install().
|
pure virtual |
name | Name of attribute to set. |
v | Value of the attribute. |
Sets one of the attributes of underlying EnergyHarvester.
Implemented in ns3::BasicEnergyHarvesterHelper.