ns3::AcousticModemEnergyModel Class Reference

WHOI micro-modem energy model. More...

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

Inheritance diagram for ns3::AcousticModemEnergyModel:
Inheritance graph
[legend]
Collaboration diagram for ns3::AcousticModemEnergyModel:
Collaboration graph
[legend]

List of all members.

Public Types

typedef Callback< void > AcousticModemEnergyDepletionCallback

Public Member Functions

virtual void SetNode (Ptr< Node > node)
 Sets pointer to node.
virtual Ptr< Node > GetNode (void) const
 Gets pointer to node.
virtual void SetEnergySource (Ptr< EnergySource > source)
 Sets pointer to EnergySouce installed on node.
virtual double GetTotalEnergyConsumption (void) const
double GetTxPowerW (void) const
void SetTxPowerW (double txPowerW)
double GetRxPowerW (void) const
void SetRxPowerW (double rxPowerW)
double GetIdlePowerW (void) const
void SetIdlePowerW (double idlePowerW)
double GetSleepPowerW (void) const
void SetSleepPowerW (double sleepPowerW)
int GetCurrentState (void) const
void SetEnergyDepletionCallback (AcousticModemEnergyDepletionCallback callback)
virtual void ChangeState (int newState)
 Changes state of the AcousticModemEnergyModel.
virtual void HandleEnergyDepletion (void)
 Handles energy depletion.

Static Public Member Functions

static TypeId GetTypeId (void)
 This method returns the TypeId associated to ns3::AcousticModemEnergyModel.

Detailed Description

WHOI micro-modem energy model.

Basing on the Device Energy Model interface, has been implemented a specific energy model for the WHOI micro modem. The class follows pretty closely the RadioEnergyModel class as the transducer behaviour is pretty close to the one of a wifi radio, with identical states (rx, tx, idle, sleep).

The power consumption values implemented into the model are as follows [1]:

Modem State Power Consumption TX 50 W RX 158 mW Idle 158 mW Sleep 5.8 mW

References: [1] Freitag et al., The whoi micro-modem: an acoustic communications and navigation system for multiple platforms, in In Proc. IEEE OCEANS05 Conf, 2005. URL: http://ieeexplore.ieee.org/iel5/10918/34367/01639901.pdf

Member Typedef Documentation

typedef Callback<void> ns3::AcousticModemEnergyModel::AcousticModemEnergyDepletionCallback

Callback type for energy depletion handling.

Member Function Documentation

virtual void ns3::AcousticModemEnergyModel::ChangeState ( int  newState  )  [virtual]

Changes state of the AcousticModemEnergyModel.

Parameters:
newState New state the modem is in.

Implements DeviceEnergyModel::ChangeState.

Implements ns3::DeviceEnergyModel.

int ns3::AcousticModemEnergyModel::GetCurrentState ( void   )  const
Returns:
Current state.
double ns3::AcousticModemEnergyModel::GetIdlePowerW ( void   )  const
Returns:
The idle power of the modem in Watts
virtual Ptr<Node> ns3::AcousticModemEnergyModel::GetNode ( void   )  const [virtual]

Gets pointer to node.

Returns:
Pointer to node.

Implements DeviceEnergyModel::GetNode.

double ns3::AcousticModemEnergyModel::GetRxPowerW ( void   )  const
Returns:
The receiving power of the modem in Watts
double ns3::AcousticModemEnergyModel::GetSleepPowerW ( void   )  const
Returns:
The sleep power of the modem in Watts
virtual double ns3::AcousticModemEnergyModel::GetTotalEnergyConsumption ( void   )  const [virtual]
Returns:
Total energy consumption of the modem

Implements DeviceEnergyModel::GetTotalEnergyConsumption.

Implements ns3::DeviceEnergyModel.

double ns3::AcousticModemEnergyModel::GetTxPowerW ( void   )  const
Returns:
The transmission power of the modem in Watts
static TypeId ns3::AcousticModemEnergyModel::GetTypeId ( void   )  [static]

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

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

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

Attributes defined for this type:

  • TxPowerW: The modem Tx power in Watts
    • Set with class: ns3::DoubleValue
    • Underlying type: double -1.79769e+308:1.79769e+308
    • Initial value: 50
    • Flags: construct write read
  • RxPowerW: The modem Rx power in Watts
    • Set with class: ns3::DoubleValue
    • Underlying type: double -1.79769e+308:1.79769e+308
    • Initial value: 0.158
    • Flags: construct write read
  • IdlePowerW: The modem Idle power in Watts
    • Set with class: ns3::DoubleValue
    • Underlying type: double -1.79769e+308:1.79769e+308
    • Initial value: 0.158
    • Flags: construct write read
  • SleepPowerW: The modem Sleep power in Watts
    • Set with class: ns3::DoubleValue
    • Underlying type: double -1.79769e+308:1.79769e+308
    • Initial value: 0.0058
    • Flags: construct write read

TraceSources defined for this type:

  • TotalEnergyConsumption: Total energy consumption of the modem device.

Reimplemented from ns3::DeviceEnergyModel.

virtual void ns3::AcousticModemEnergyModel::HandleEnergyDepletion ( void   )  [virtual]

Handles energy depletion.

Implements DeviceEnergyModel::HandleEnergyDepletion

Implements ns3::DeviceEnergyModel.

void ns3::AcousticModemEnergyModel::SetEnergyDepletionCallback ( AcousticModemEnergyDepletionCallback  callback  ) 
Parameters:
callback Callback function.

Sets callback for energy depletion handling.

virtual void ns3::AcousticModemEnergyModel::SetEnergySource ( Ptr< EnergySource >  source  )  [virtual]

Sets pointer to EnergySouce installed on node.

Parameters:
source Pointer to EnergySource installed on node.

Implements DeviceEnergyModel::SetEnergySource.

Implements ns3::DeviceEnergyModel.

void ns3::AcousticModemEnergyModel::SetIdlePowerW ( double  idlePowerW  ) 

Set the idle power of the modem

Parameters:
idlePowerW Idle power of the modem in watts
virtual void ns3::AcousticModemEnergyModel::SetNode ( Ptr< Node >  node  )  [virtual]

Sets pointer to node.

Parameters:
node Pointer to node.

Implements DeviceEnergyModel::SetNode.

void ns3::AcousticModemEnergyModel::SetRxPowerW ( double  rxPowerW  ) 

Set the receiving power of the modem

Parameters:
rxPowerW Receiving power of the modem in watts
void ns3::AcousticModemEnergyModel::SetSleepPowerW ( double  sleepPowerW  ) 

Set the sleep power of the modem

Parameters:
sleepPowerW Sleep power of the modem in watts
void ns3::AcousticModemEnergyModel::SetTxPowerW ( double  txPowerW  ) 

Set the transmission power of the modem

Parameters:
txPowerW Transmission power of the modem in watts
The documentation for this class was generated from the following files:
Generated on 6 Jan 2011 for NS-3 by  doxygen 1.6.1