Holds a vector of ns3::DeviceEnergyModel pointers. More...

#include "device-energy-model-container.h"

Collaboration diagram for ns3::DeviceEnergyModelContainer:

Public Types
typedef std::vector< Ptr< DeviceEnergyModel > >::const_iterator	Iterator

Public Member Functions
	DeviceEnergyModelContainer ()
	Creates an empty DeviceEnergyModelContainer. More...

	DeviceEnergyModelContainer (Ptr< DeviceEnergyModel > model)

	DeviceEnergyModelContainer (std::string modelName)

	DeviceEnergyModelContainer (const DeviceEnergyModelContainer &a, const DeviceEnergyModelContainer &b)

void	Add (DeviceEnergyModelContainer container)

void	Add (Ptr< DeviceEnergyModel > model)
	Append a single Ptr<DeviceEnergyModel> to the end of this container. More...

void	Add (std::string modelName)
	Append a single Ptr<DeviceEnergyModel> referred to by its object name to the end of this container. More...

Iterator	Begin (void) const
	Get an iterator which refers to the first DeviceEnergyModel pointer in the container. More...

void	Clear (void)
	Removes all elements in the container. More...

Iterator	End (void) const
	Get an iterator which refers to the last DeviceEnergyModel pointer in the container. More...

Ptr< DeviceEnergyModel >	Get (uint32_t i) const
	Get the i-th Ptr<DeviceEnergyModel> stored in this container. More...

uint32_t	GetN (void) const
	Get the number of Ptr<DeviceEnergyModel> stored in this container. More...

Private Attributes
std::vector< Ptr< DeviceEnergyModel > >	m_models

Detailed Description

Holds a vector of ns3::DeviceEnergyModel pointers.

DeviceEnergyModelContainer returns a list of DeviceEnergyModel pointers installed on a node. Users can use this list to access DeviceEnergyModel objects to obtain total device energy consumption on a node easily.

See also: NetDeviceContainer

Definition at line 43 of file device-energy-model-container.h.

Member Typedef Documentation

◆ Iterator

typedef std::vector< Ptr<DeviceEnergyModel> >::const_iterator ns3::DeviceEnergyModelContainer::Iterator

Definition at line 46 of file device-energy-model-container.h.

Constructor & Destructor Documentation

◆ DeviceEnergyModelContainer() [1/4]

ns3::DeviceEnergyModelContainer::DeviceEnergyModelContainer ( )

Creates an empty DeviceEnergyModelContainer.

Definition at line 31 of file device-energy-model-container.cc.

References NS_LOG_FUNCTION.

◆ DeviceEnergyModelContainer() [2/4]

ns3::DeviceEnergyModelContainer::DeviceEnergyModelContainer ( Ptr< DeviceEnergyModel > model )

Parameters

model Pointer to a DeviceEnergyModel.

Creates a DeviceEnergyModelContainer with exactly one DeviceEnergyModel previously instantiated.

Definition at line 36 of file device-energy-model-container.cc.

References m_models, NS_ASSERT, and NS_LOG_FUNCTION.

◆ DeviceEnergyModelContainer() [3/4]

ns3::DeviceEnergyModelContainer::DeviceEnergyModelContainer ( std::string modelName )

Parameters

modelName Name of DeviceEnergyModel.

Creates an DeviceEnergyModelContainer with exactly one DeviceEnergyModel previously instantiated and assigned a name using the Object name service. This DeviceEnergyModel is specified by its assigned name.

Definition at line 43 of file device-energy-model-container.cc.

References m_models, NS_ASSERT, and NS_LOG_FUNCTION.

◆ DeviceEnergyModelContainer() [4/4]

ns3::DeviceEnergyModelContainer::DeviceEnergyModelContainer	(	const DeviceEnergyModelContainer &	a,
		const DeviceEnergyModelContainer &	b
	)

Parameters

a	A DeviceEnergyModelContainer.
b	Another DeviceEnergyModelContainer.

Creates a DeviceEnergyModelContainer by concatenating DeviceEnergyModelContainer b to DeviceEnergyModelContainer a.

Note: Can be used to concatenate 2 Ptr<DeviceEnergyModel> directly. C++ will be calling DeviceEnergyModelContainer constructor with Ptr<DeviceEnergyModel> first.

Definition at line 51 of file device-energy-model-container.cc.

References Add(), and NS_LOG_FUNCTION.

Here is the call graph for this function:

Member Function Documentation

◆ Add() [1/3]

void ns3::DeviceEnergyModelContainer::Add ( DeviceEnergyModelContainer container )

Parameters

container Another DeviceEnergyModelContainer.

Appends the contents of another DeviceEnergyModelContainer to the end of this DeviceEnergyModelContainer.

Definition at line 88 of file device-energy-model-container.cc.

References Begin(), End(), m_models, and NS_LOG_FUNCTION.

Referenced by ns3::EnergySource::AppendDeviceEnergyModel(), DeviceEnergyModelContainer(), and ns3::EnergySource::FindDeviceEnergyModels().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Add() [2/3]

void ns3::DeviceEnergyModelContainer::Add ( Ptr< DeviceEnergyModel > model )

Append a single Ptr<DeviceEnergyModel> to the end of this container.

Parameters

model Pointer to an DeviceEnergyModel.

Definition at line 98 of file device-energy-model-container.cc.

References m_models, NS_ASSERT, and NS_LOG_FUNCTION.

◆ Add() [3/3]

void ns3::DeviceEnergyModelContainer::Add ( std::string modelName )

Append a single Ptr<DeviceEnergyModel> referred to by its object name to the end of this container.

Parameters

modelName Name of DeviceEnergyModel object.

Definition at line 106 of file device-energy-model-container.cc.

References m_models, NS_ASSERT, and NS_LOG_FUNCTION.

◆ Begin()

DeviceEnergyModelContainer::Iterator ns3::DeviceEnergyModelContainer::Begin ( void ) const

Get an iterator which refers to the first DeviceEnergyModel pointer in the container.

Returns: An iterator which refers to the first DeviceEnergyModel in container.

DeviceEnergyModels can be retrieved from the container in two ways. First, directly by an index into the container, and second, using an iterator. This method is used in the iterator method and is typically used in a for-loop to run through the DeviceEnergyModels.

DeviceEnergyModelContainer::Iterator i;
for (i = container.Begin (); i != container.End (); ++i)
  {
    (*i)->method ();  // some DeviceEnergyModel method
  }

Definition at line 60 of file device-energy-model-container.cc.

References m_models, and NS_LOG_FUNCTION.

Referenced by Add(), ns3::EnergySource::CalculateTotalCurrent(), ns3::EnergySource::DisposeDeviceModels(), ns3::EnergySource::FindDeviceEnergyModels(), ns3::EnergySource::InitializeDeviceModels(), ns3::EnergySource::NotifyEnergyChanged(), ns3::EnergySource::NotifyEnergyDrained(), and ns3::EnergySource::NotifyEnergyRecharged().

Here is the caller graph for this function:

◆ Clear()

void ns3::DeviceEnergyModelContainer::Clear ( void )

Removes all elements in the container.

Definition at line 115 of file device-energy-model-container.cc.

References m_models, and NS_LOG_FUNCTION.

Referenced by ns3::EnergySource::BreakDeviceEnergyModelRefCycle().

Here is the caller graph for this function:

◆ End()

DeviceEnergyModelContainer::Iterator ns3::DeviceEnergyModelContainer::End ( void ) const

Get an iterator which refers to the last DeviceEnergyModel pointer in the container.

Returns: An iterator which refers to the last DeviceEnergyModel in container.

DeviceEnergyModels can be retrieved from the container in two ways. First, directly by an index into the container, and second, using an iterator. This method is used in the iterator method and is typically used in a for-loop to run through the DeviceEnergyModels.

DeviceEnergyModelContainer::Iterator i;
for (i = container.Begin (); i != container.End (); ++i)
  {
    (*i)->method ();  // some DeviceEnergyModel method
  }

Definition at line 67 of file device-energy-model-container.cc.

References m_models, and NS_LOG_FUNCTION.

Referenced by Add(), ns3::EnergySource::CalculateTotalCurrent(), ns3::EnergySource::DisposeDeviceModels(), ns3::EnergySource::FindDeviceEnergyModels(), ns3::EnergySource::InitializeDeviceModels(), ns3::EnergySource::NotifyEnergyChanged(), ns3::EnergySource::NotifyEnergyDrained(), and ns3::EnergySource::NotifyEnergyRecharged().

Here is the caller graph for this function: