A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Member Functions | Private Member Functions | Private Attributes | List of all members
ns3::AcousticModemEnergyModelHelper Class Reference

Assign AcousticModemEnergyModel to uan devices. More...

#include <acoustic-modem-energy-model-helper.h>

+ Inheritance diagram for ns3::AcousticModemEnergyModelHelper:

Public Member Functions

 AcousticModemEnergyModelHelper ()
 
 ~AcousticModemEnergyModelHelper ()
 
void Set (std::string name, const AttributeValue &v)
 
void SetDepletionCallback (AcousticModemEnergyModel::AcousticModemEnergyDepletionCallback callback)
 
- Public Member Functions inherited from ns3::DeviceEnergyModelHelper
DeviceEnergyModelContainer Install (Ptr< NetDevice > device, Ptr< EnergySource > source) const
 
DeviceEnergyModelContainer Install (NetDeviceContainer deviceContainer, EnergySourceContainer sourceContainer) const
 

Private Member Functions

virtual Ptr< DeviceEnergyModel > DoInstall (Ptr< NetDevice > device, Ptr< EnergySource > source) const
 

Private Attributes

AcousticModemEnergyModel::AcousticModemEnergyDepletionCallback m_depletionCallback
 
ObjectFactory m_modemEnergy
 

Detailed Description

Assign AcousticModemEnergyModel to uan devices.

This installer installs AcousticModemEnergyModel for only UanNetDevice objects.

Definition at line 34 of file acoustic-modem-energy-model-helper.h.

Constructor & Destructor Documentation

ns3::AcousticModemEnergyModelHelper::AcousticModemEnergyModelHelper ( )

Construct a helper which is used to add a radio energy model to a node

Definition at line 30 of file acoustic-modem-energy-model-helper.cc.

References ns3::ObjectFactory::SetTypeId().

ns3::AcousticModemEnergyModelHelper::~AcousticModemEnergyModelHelper ( )

Destroy an AcousticModemEnergy Helper

Definition at line 36 of file acoustic-modem-energy-model-helper.cc.

Member Function Documentation

Ptr< DeviceEnergyModel > ns3::AcousticModemEnergyModelHelper::DoInstall ( Ptr< NetDevice >  device,
Ptr< EnergySource >  source 
) const
privatevirtual
Parameters
devicePointer to the NetDevice to install DeviceEnergyModel.
sourcePointer to EnergySource installed on node.

Implements DeviceEnergyModel::Install.

Implements ns3::DeviceEnergyModelHelper.

Definition at line 58 of file acoustic-modem-energy-model-helper.cc.

References ns3::DeviceEnergyModel::ChangeState(), ns3::ObjectFactory::Create(), ns3::MakeCallback(), NS_ASSERT, and NS_FATAL_ERROR.

void ns3::AcousticModemEnergyModelHelper::Set ( std::string  name,
const AttributeValue &  v 
)
virtual
Parameters
namethe name of the attribute to set
vthe value of the attribute

Sets an attribute of the underlying energy model object.

Implements ns3::DeviceEnergyModelHelper.

Definition at line 41 of file acoustic-modem-energy-model-helper.cc.

References ns3::ObjectFactory::Set().

void ns3::AcousticModemEnergyModelHelper::SetDepletionCallback ( AcousticModemEnergyModel::AcousticModemEnergyDepletionCallback  callback)
Parameters
callbackCallback function for energy depletion handling.

Sets the callback to be invoked when energy is depleted.

Definition at line 47 of file acoustic-modem-energy-model-helper.cc.

Referenced by ns3::AcousticModemEnergyDepletionTestCase::DoRun().

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