#include <basic-energy-source.h>

Inheritance diagram for ns3::BasicEnergySource:

Collaboration diagram for ns3::BasicEnergySource:

Public Member Functions
	BasicEnergySource ()
virtual	~BasicEnergySource ()
virtual double	GetEnergyFraction (void)
Time	GetEnergyUpdateInterval (void) const
virtual double	GetInitialEnergy (void) const
virtual double	GetRemainingEnergy (void)
virtual double	GetSupplyVoltage (void) const
void	SetEnergyUpdateInterval (Time interval)
void	SetInitialEnergy (double initialEnergyJ)
void	SetSupplyVoltage (double supplyVoltageV)
virtual void	UpdateEnergySource (void)
Public Member Functions inherited from ns3::EnergySource
	EnergySource ()
virtual	~EnergySource ()
void	AppendDeviceEnergyModel (Ptr< DeviceEnergyModel > deviceEnergyModelPtr)
void	DisposeDeviceModels (void)
DeviceEnergyModelContainer	FindDeviceEnergyModels (TypeId tid)
DeviceEnergyModelContainer	FindDeviceEnergyModels (std::string name)
Ptr< Node >	GetNode (void) const
void	InitializeDeviceModels (void)
void	SetNode (Ptr< Node > node)
	Sets pointer to node containing this EnergySource.
Public Member Functions inherited from ns3::Object
	Object ()
virtual	~Object ()
void	AggregateObject (Ptr< Object > other)
void	Dispose (void)
AggregateIterator	GetAggregateIterator (void) const
virtual TypeId	GetInstanceTypeId (void) const
template<typename T >
Ptr< T >	GetObject (void) const
template<typename T >
Ptr< T >	GetObject (TypeId tid) const
void	Initialize (void)
Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	SimpleRefCount (const SimpleRefCount &o)
uint32_t	GetReferenceCount (void) const
SimpleRefCount &	operator= (const SimpleRefCount &o)
void	Ref (void) const
void	Unref (void) const
Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
void	GetAttribute (std::string name, AttributeValue &value) const
bool	GetAttributeFailSafe (std::string name, AttributeValue &attribute) const
void	SetAttribute (std::string name, const AttributeValue &value)
bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)
bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)
bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)

Static Public Member Functions
static TypeId	GetTypeId (void)

Private Member Functions
void	CalculateRemainingEnergy (void)
void	DoDispose (void)
	Defined in ns3::Object.
void	DoInitialize (void)
	Defined in ns3::Object.
void	HandleEnergyDrainedEvent (void)

Private Attributes
EventId	m_energyUpdateEvent
Time	m_energyUpdateInterval
double	m_initialEnergyJ
Time	m_lastUpdateTime
TracedValue< double >	m_remainingEnergyJ
double	m_supplyVoltageV

Additional Inherited Members
Protected Member Functions inherited from ns3::EnergySource
void	BreakDeviceEnergyModelRefCycle (void)
double	CalculateTotalCurrent (void)
void	NotifyEnergyDrained (void)

Detailed Description

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

Doxygen introspection did not find any typical Config paths.

Attributes

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: +1000000000.0ns
- Flags: construct write read

TraceSources

RemainingEnergy: Remaining energy at BasicEnergySource.

Definition at line 37 of file basic-energy-source.h.

Constructor & Destructor Documentation

ns3::BasicEnergySource::BasicEnergySource ( )

Definition at line 65 of file basic-energy-source.cc.

References m_lastUpdateTime, NS_LOG_FUNCTION, and ns3::Seconds().

Here is the call graph for this function:

ns3::BasicEnergySource::~BasicEnergySource ( )

virtual

Definition at line 71 of file basic-energy-source.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

void ns3::BasicEnergySource::CalculateRemainingEnergy ( void )

private

Calculates remaining energy. This function uses the total current from all device models to calculate the amount of energy to decrease. The energy to decrease is given by: energy to decrease = total current * supply voltage * time duration This function subtracts the calculated energy to decrease from remaining energy.

Definition at line 195 of file basic-energy-source.cc.

References ns3::EnergySource::CalculateTotalCurrent(), ns3::Time::GetSeconds(), m_lastUpdateTime, m_remainingEnergyJ, m_supplyVoltageV, ns3::Now(), NS_ASSERT, NS_LOG_DEBUG, and NS_LOG_FUNCTION.

Referenced by UpdateEnergySource().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::BasicEnergySource::DoDispose ( void )

private

Defined in ns3::Object.

Definition at line 179 of file basic-energy-source.cc.

References ns3::EnergySource::BreakDeviceEnergyModelRefCycle(), and NS_LOG_FUNCTION.

Here is the call graph for this function:

void ns3::BasicEnergySource::DoInitialize ( void )

private

Defined in ns3::Object.

Definition at line 172 of file basic-energy-source.cc.

References NS_LOG_FUNCTION, and UpdateEnergySource().

Here is the call graph for this function:

double ns3::BasicEnergySource::GetEnergyFraction ( void )

virtual

Returns: Energy fraction.

Implements GetEnergyFraction.

Implements ns3::EnergySource.

Definition at line 130 of file basic-energy-source.cc.

References m_initialEnergyJ, m_remainingEnergyJ, NS_LOG_FUNCTION, and UpdateEnergySource().

Here is the call graph for this function:

Time ns3::BasicEnergySource::GetEnergyUpdateInterval ( void ) const

Returns: The interval between each energy update.

Definition at line 100 of file basic-energy-source.cc.

References m_energyUpdateInterval, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

Here is the caller graph for this function:

double ns3::BasicEnergySource::GetInitialEnergy ( void ) const

virtual

Returns: Initial energy stored in energy source, in Joules.

Implements GetInitialEnergy.

Implements ns3::EnergySource.

Definition at line 114 of file basic-energy-source.cc.

References m_initialEnergyJ, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

Here is the caller graph for this function:

double ns3::BasicEnergySource::GetRemainingEnergy ( void )

virtual

Returns: Remaining energy in energy source, in Joules

Implements GetRemainingEnergy.

Implements ns3::EnergySource.

Definition at line 121 of file basic-energy-source.cc.

References m_remainingEnergyJ, NS_LOG_FUNCTION, and UpdateEnergySource().

Here is the call graph for this function:

double ns3::BasicEnergySource::GetSupplyVoltage ( void ) const

virtual

Returns: Supply voltage at the energy source.

Implements GetSupplyVoltage.

Implements ns3::EnergySource.

Definition at line 107 of file basic-energy-source.cc.

References m_supplyVoltageV, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

Here is the caller graph for this function:

TypeId ns3::BasicEnergySource::GetTypeId ( void )

static

Reimplemented from ns3::EnergySource.

Definition at line 35 of file basic-energy-source.cc.

References GetEnergyUpdateInterval(), GetInitialEnergy(), GetSupplyVoltage(), m_remainingEnergyJ, ns3::MakeTraceSourceAccessor(), ns3::Seconds(), SetEnergyUpdateInterval(), SetInitialEnergy(), ns3::TypeId::SetParent(), and SetSupplyVoltage().

Here is the call graph for this function:

void ns3::BasicEnergySource::HandleEnergyDrainedEvent ( void )

private

Handles the remaining energy going to zero event. This function notifies all the energy models aggregated to the node about the energy being depleted. Each energy model is then responsible for its own handler.

Definition at line 186 of file basic-energy-source.cc.

References m_remainingEnergyJ, ns3::EnergySource::NotifyEnergyDrained(), NS_LOG_DEBUG, and NS_LOG_FUNCTION.

Referenced by UpdateEnergySource().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::BasicEnergySource::SetEnergyUpdateInterval ( Time interval )

Parameters

interval Energy update interval.

This function sets the interval between each energy update.

Definition at line 93 of file basic-energy-source.cc.

References m_energyUpdateInterval, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

Here is the caller graph for this function:

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.

Definition at line 77 of file basic-energy-source.cc.

References m_initialEnergyJ, m_remainingEnergyJ, NS_ASSERT, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

Here is the caller graph for this function: