ns-3
Public Types | Public Member Functions | Static Public Member Functions
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 Types inherited from ns3::DeviceEnergyModel
typedef Callback< void, int > ChangeStateCallback

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.
- Public Member Functions inherited from ns3::DeviceEnergyModel
double GetCurrentA (void) const
- Public Member Functions inherited from ns3::Object
virtual TypeId GetInstanceTypeId (void) const
template<typename T >
Ptr< T > GetObject (void) const
template<typename T >
Ptr< T > GetObject (TypeId tid) const
void Dispose (void)
void AggregateObject (Ptr< Object > other)
AggregateIterator GetAggregateIterator (void) const
void Start (void)
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount (const SimpleRefCount &o)
SimpleRefCount & operator= (const SimpleRefCount &o)
void Ref (void) const
void Unref (void) const
uint32_t GetReferenceCount (void) const
- Public Member Functions inherited from ns3::ObjectBase
void SetAttribute (std::string name, const AttributeValue &value)
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
void GetAttribute (std::string name, AttributeValue &value) const
bool GetAttributeFailSafe (std::string name, AttributeValue &attribute) const
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)
 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

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

Changes state of the AcousticModemEnergyModel.

Parameters:
newStateNew state the modem is in.

Implements DeviceEnergyModel::ChangeState.

Implements ns3::DeviceEnergyModel.

References ns3::Node::GetId(), ns3::Time::GetNanoSeconds(), ns3::Time::GetSeconds(), ns3::EnergySource::GetSupplyVoltage(), ns3::Now(), NS_ASSERT, NS_FATAL_ERROR, NS_LOG_DEBUG, NS_LOG_FUNCTION, and ns3::EnergySource::UpdateEnergySource().

int ns3::AcousticModemEnergyModel::GetCurrentState ( void  ) const
Returns:
Current state.

References NS_LOG_FUNCTION.

double ns3::AcousticModemEnergyModel::GetIdlePowerW ( void  ) const
Returns:
The idle power of the modem in Watts

References NS_LOG_FUNCTION.

Referenced by GetTypeId().

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

References NS_LOG_FUNCTION.

Referenced by GetTypeId().

double ns3::AcousticModemEnergyModel::GetSleepPowerW ( void  ) const
Returns:
The sleep power of the modem in Watts

References NS_LOG_FUNCTION.

Referenced by GetTypeId().

double ns3::AcousticModemEnergyModel::GetTotalEnergyConsumption ( void  ) const
virtual
Returns:
Total energy consumption of the modem

Implements DeviceEnergyModel::GetTotalEnergyConsumption.

Implements ns3::DeviceEnergyModel.

References NS_LOG_FUNCTION.

double ns3::AcousticModemEnergyModel::GetTxPowerW ( void  ) const
Returns:
The transmission power of the modem in Watts

References NS_LOG_FUNCTION.

Referenced by GetTypeId().

TypeId ns3::AcousticModemEnergyModel::GetTypeId ( void  )
static

This method returns the TypeId associated to 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.

References GetIdlePowerW(), GetRxPowerW(), GetSleepPowerW(), GetTxPowerW(), ns3::MakeTraceSourceAccessor(), SetIdlePowerW(), ns3::TypeId::SetParent(), SetRxPowerW(), SetSleepPowerW(), and SetTxPowerW().

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

Handles energy depletion.

Implements DeviceEnergyModel::HandleEnergyDepletion

Implements ns3::DeviceEnergyModel.

References ns3::UanPhy::EnergyDepletionHandler(), ns3::Node::GetDevice(), ns3::Node::GetId(), ns3::Object::GetObject(), ns3::UanNetDevice::GetPhy(), NS_LOG_DEBUG, and NS_LOG_FUNCTION.

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

Sets callback for energy depletion handling.

References NS_LOG_DEBUG, and NS_LOG_FUNCTION.

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

Sets pointer to EnergySouce installed on node.

Parameters:
sourcePointer to EnergySource installed on node.

Implements DeviceEnergyModel::SetEnergySource.

Implements ns3::DeviceEnergyModel.

References NS_ASSERT, and NS_LOG_FUNCTION.

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

Set the idle power of the modem

Parameters:
idlePowerWIdle power of the modem in watts

References NS_LOG_FUNCTION.

Referenced by GetTypeId().

void ns3::AcousticModemEnergyModel::SetNode ( Ptr< Node >  node)
virtual

Sets pointer to node.

Parameters:
nodePointer to node.

Implements DeviceEnergyModel::SetNode.

References NS_ASSERT, and NS_LOG_FUNCTION.

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

Set the receiving power of the modem

Parameters:
rxPowerWReceiving power of the modem in watts

References NS_LOG_FUNCTION.

Referenced by GetTypeId().

void ns3::AcousticModemEnergyModel::SetSleepPowerW ( double  sleepPowerW)

Set the sleep power of the modem

Parameters:
sleepPowerWSleep power of the modem in watts

References NS_LOG_FUNCTION.

Referenced by GetTypeId().

void ns3::AcousticModemEnergyModel::SetTxPowerW ( double  txPowerW)

Set the transmission power of the modem

Parameters:
txPowerWTransmission power of the modem in watts

References NS_LOG_FUNCTION.

Referenced by GetTypeId().

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