ns3::BasicEnergySource Class Reference

#include <basic-energy-source.h>

Inheritance diagram for ns3::BasicEnergySource:

[legend]

Collaboration diagram for ns3::BasicEnergySource:

[legend]

List of all members.

Public Member Functions
virtual double	GetInitialEnergy (void) const
virtual double	GetSupplyVoltage (void) const
virtual double	GetRemainingEnergy (void)
virtual double	GetEnergyFraction (void)
virtual void	UpdateEnergySource (void)
void	SetInitialEnergy (double initialEnergyJ)
void	SetSupplyVoltage (double supplyVoltageV)
void	SetEnergyUpdateInterval (Time interval)
Time	GetEnergyUpdateInterval (void) const
Static Public Member Functions
static TypeId	GetTypeId (void)
	This method returns the TypeId associated to ns3::BasicEnergySource.

---

Detailed Description

BasicEnergySource decreases/increases remaining energy stored in itself in linearly.

---

Member Function Documentation

virtual double ns3::BasicEnergySource::GetEnergyFraction

(

void

)

[virtual]

Returns:

Energy fraction.

Implements GetEnergyFraction.

Implements ns3::EnergySource.

Time ns3::BasicEnergySource::GetEnergyUpdateInterval

(

void

)

const

Returns:

The interval between each energy update.

virtual double ns3::BasicEnergySource::GetInitialEnergy

(

void

)

const [virtual]

Returns:

Initial energy stored in energy source, in Joules.

Implements GetInitialEnergy.

Implements ns3::EnergySource.

virtual double ns3::BasicEnergySource::GetRemainingEnergy

(

void

)

[virtual]

Returns:

Remaining energy in energy source, in Joules

Implements GetRemainingEnergy.

Implements ns3::EnergySource.

virtual double ns3::BasicEnergySource::GetSupplyVoltage

(

void

)

const [virtual]

Returns:

Supply voltage at the energy source.

Implements GetSupplyVoltage.

Implements ns3::EnergySource.

static TypeId ns3::BasicEnergySource::GetTypeId

(

void

)

[static]

This method returns the TypeId associated to ns3::BasicEnergySource.

This object is accessible through the following paths with Config::Set and Config::Connect:

• /NodeList/[i]/DeviceList/[i]/$ns3::AlohaNoackNetDevice/Phy/$ns3::BasicEnergySource
• /NodeList/[i]/DeviceList/[i]/$ns3::AlohaNoackNetDevice/Phy/$ns3::EnergySource/$ns3::BasicEnergySource
• /NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/BsIpcsPacketClassifier/$ns3::BasicEnergySource
• /NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/BsIpcsPacketClassifier/$ns3::EnergySource/$ns3::BasicEnergySource
• /NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/LinkManager/$ns3::BasicEnergySource
• /NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/LinkManager/$ns3::EnergySource/$ns3::BasicEnergySource
• /NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/SSManager/$ns3::BasicEnergySource
• /NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/SSManager/$ns3::EnergySource/$ns3::BasicEnergySource
• /NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/ServiceFlowManager/$ns3::BasicEnergySource
• /NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/ServiceFlowManager/$ns3::EnergySource/$ns3::BasicEnergySource
• /NodeList/[i]/DeviceList/[i]/$ns3::NonCommunicatingNetDevice/Phy/$ns3::BasicEnergySource
• /NodeList/[i]/DeviceList/[i]/$ns3::NonCommunicatingNetDevice/Phy/$ns3::EnergySource/$ns3::BasicEnergySource
• /NodeList/[i]/DeviceList/[i]/$ns3::SubscriberStationNetDevice/Classifier/$ns3::BasicEnergySource
• /NodeList/[i]/DeviceList/[i]/$ns3::SubscriberStationNetDevice/Classifier/$ns3::EnergySource/$ns3::BasicEnergySource
• /NodeList/[i]/DeviceList/[i]/$ns3::SubscriberStationNetDevice/LinkManager/$ns3::BasicEnergySource
• /NodeList/[i]/DeviceList/[i]/$ns3::SubscriberStationNetDevice/LinkManager/$ns3::EnergySource/$ns3::BasicEnergySource
• /NodeList/[i]/DeviceList/[i]/$ns3::SubscriberStationNetDevice/SSScheduler/$ns3::BasicEnergySource
• /NodeList/[i]/DeviceList/[i]/$ns3::SubscriberStationNetDevice/SSScheduler/$ns3::EnergySource/$ns3::BasicEnergySource
• /NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Channel/NoiseModel/$ns3::BasicEnergySource
• /NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Channel/NoiseModel/$ns3::EnergySource/$ns3::BasicEnergySource
• /NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Channel/PropagationModel/$ns3::BasicEnergySource
• /NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Channel/PropagationModel/$ns3::EnergySource/$ns3::BasicEnergySource
• /NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Mac/$ns3::BasicEnergySource
• /NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Mac/$ns3::EnergySource/$ns3::BasicEnergySource
• /NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Phy/$ns3::BasicEnergySource
• /NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Phy/$ns3::EnergySource/$ns3::BasicEnergySource
• /NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Transducer/$ns3::BasicEnergySource
• /NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Transducer/$ns3::EnergySource/$ns3::BasicEnergySource
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/BsIpcsPacketClassifier/$ns3::BasicEnergySource
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/BsIpcsPacketClassifier/$ns3::EnergySource/$ns3::BasicEnergySource
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/LinkManager/$ns3::BasicEnergySource
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/LinkManager/$ns3::EnergySource/$ns3::BasicEnergySource
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/SSManager/$ns3::BasicEnergySource
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/SSManager/$ns3::EnergySource/$ns3::BasicEnergySource
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/ServiceFlowManager/$ns3::BasicEnergySource
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/ServiceFlowManager/$ns3::EnergySource/$ns3::BasicEnergySource
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::SubscriberStationNetDevice/Classifier/$ns3::BasicEnergySource
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::SubscriberStationNetDevice/Classifier/$ns3::EnergySource/$ns3::BasicEnergySource
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::SubscriberStationNetDevice/LinkManager/$ns3::BasicEnergySource
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::SubscriberStationNetDevice/LinkManager/$ns3::EnergySource/$ns3::BasicEnergySource
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::SubscriberStationNetDevice/SSScheduler/$ns3::BasicEnergySource
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::SubscriberStationNetDevice/SSScheduler/$ns3::EnergySource/$ns3::BasicEnergySource
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/BandwidthManager/$ns3::BasicEnergySource
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/BandwidthManager/$ns3::EnergySource/$ns3::BasicEnergySource
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/BurstProfileManager/$ns3::BasicEnergySource
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/BurstProfileManager/$ns3::EnergySource/$ns3::BasicEnergySource
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/Channel/$ns3::UanChannel/NoiseModel/$ns3::BasicEnergySource
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/Channel/$ns3::UanChannel/NoiseModel/$ns3::EnergySource/$ns3::BasicEnergySource
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/Channel/$ns3::UanChannel/PropagationModel/$ns3::BasicEnergySource
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/Channel/$ns3::UanChannel/PropagationModel/$ns3::EnergySource/$ns3::BasicEnergySource
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/ConnectionManager/$ns3::BasicEnergySource
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/ConnectionManager/$ns3::EnergySource/$ns3::BasicEnergySource
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/Phy/Channel/$ns3::UanChannel/NoiseModel/$ns3::BasicEnergySource
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/Phy/Channel/$ns3::UanChannel/NoiseModel/$ns3::EnergySource/$ns3::BasicEnergySource
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/Phy/Channel/$ns3::UanChannel/PropagationModel/$ns3::BasicEnergySource
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/Phy/Channel/$ns3::UanChannel/PropagationModel/$ns3::EnergySource/$ns3::BasicEnergySource

Attributes defined for this type:

• BasicEnergySourceInitialEnergyJ: Initial energy stored in basic energy source.
  • Set with class: ns3::DoubleValue
  • Underlying type: double -1.79769e+308:1.79769e+308
  • Initial value: 10
  • Flags: construct write read
• BasicEnergySupplyVoltageV: Initial supply voltage for basic energy source.
  • Set with class: ns3::DoubleValue
  • Underlying type: double -1.79769e+308:1.79769e+308
  • Initial value: 3
  • Flags: construct write read
• PeriodicEnergyUpdateInterval: Time between two consecutive periodic energy updates.
  • Set with class: TimeValue
  • Underlying type: Time
  • Initial value: 1000000000ns
  • Flags: construct write read

TraceSources defined for this type:

• RemainingEnergy: Remaining energy at BasicEnergySource.

Reimplemented from ns3::EnergySource.

void ns3::BasicEnergySource::SetEnergyUpdateInterval

(

Time

interval

)

Parameters:

interval

Energy update interval.

This function sets the interval between each energy update.

void ns3::BasicEnergySource::SetInitialEnergy

(

double

initialEnergyJ

)

Parameters:

initialEnergyJ

Initial energy, in Joules

Sets initial energy stored in the energy source. Note that initial energy is assumed to be set before simulation starts and is set only once per simulation.

void ns3::BasicEnergySource::SetSupplyVoltage

(

double

supplyVoltageV

)

Parameters:

supplyVoltageV

Supply voltage at the energy source, in Volts.

Sets supply voltage of the energy source.

virtual void ns3::BasicEnergySource::UpdateEnergySource

(

void

)

[virtual]

Implements UpdateEnergySource.

Implements ns3::EnergySource.

---

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

• src/contrib/energy/model/basic-energy-source.h
• doc/introspected-doxygen.h