ns3::EnergySourceHelper Class Reference
Creates EnergySource objects. More...
#include <energy-model-helper.h>
Inheritance diagram for ns3::EnergySourceHelper:
Public Member Functions | |
| virtual void | Set (std::string name, const AttributeValue &v)=0 |
| 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. | |
Detailed Description
Creates EnergySource objects.
This class creates and installs an energy source onto network nodes. Only a single source can exist on a network node.
Member Function Documentation
| EnergySourceContainer ns3::EnergySourceHelper::Install | ( | std::string | nodeName | ) | const |
- Parameters:
-
nodeName Name of node where EnergySource will be installed.
- Returns:
- An EnergySourceContainer which contains all the EnergySources.
This function installs an EnergySource onto a node.
| EnergySourceContainer ns3::EnergySourceHelper::Install | ( | NodeContainer | c | ) | const |
- Parameters:
-
c List of nodes where EnergySource will be installed.
- Returns:
- An EnergySourceContainer which contains all the EnergySources.
This function installs an EnergySource onto a list of nodes.
| EnergySourceContainer ns3::EnergySourceHelper::Install | ( | Ptr< Node > | node | ) | const |
- Parameters:
-
node Pointer to the node where EnergySource will be installed.
- Returns:
- An EnergySourceContainer which contains all the EnergySources.
This function installs an EnergySource onto a node.
| EnergySourceContainer ns3::EnergySourceHelper::InstallAll | ( | void | ) | const |
This function installs an EnergySource on all nodes in simulation.
- Returns:
- An EnergySourceContainer which contains all the EnergySources.
| virtual void ns3::EnergySourceHelper::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 EnergySource.
Implemented in ns3::BasicEnergySourceHelper, and ns3::RvBatteryModelHelper.
The documentation for this class was generated from the following file:
- src/contrib/energy/helper/energy-model-helper.h
