A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
ns3::UanNoiseModel Class Referenceabstract

UAN Noise Model base class. More...

#include <uan-noise-model.h>

+ Inheritance diagram for ns3::UanNoiseModel:
+ Collaboration diagram for ns3::UanNoiseModel:

Public Member Functions

virtual void Clear (void)
 Clear all pointer references. More...
 
virtual void DoDispose (void)
 This method is called by Object::Dispose or by the object's destructor, whichever comes first. More...
 
virtual double GetNoiseDbHz (double fKhz) const =0
 Compute the noise power at a given frequency. More...
 
- Public Member Functions inherited from ns3::Object
 Object ()
 
virtual ~Object ()
 
void AggregateObject (Ptr< Object > other)
 
void Dispose (void)
 Run the DoDispose methods of this object and all the objects aggregated to it. More...
 
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)
 This method calls the virtual DoInitialize method on all the objects aggregated to this object. More...
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 Constructor. More...
 
 SimpleRefCount (const SimpleRefCount &o)
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 Assignment. More...
 
void Ref (void) const
 Increment the reference count. More...
 
void Unref (void) const
 Decrement the reference count. More...
 
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
 Virtual destructor. More...
 
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)
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId (void)
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void Cleanup (void)
 Noop. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 Get the type ID. More...
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 
virtual void DoInitialize (void)
 This method is called only once by Object::Initialize. More...
 
virtual void NotifyNewAggregate (void)
 This method is invoked whenever two sets of objects are aggregated together. More...
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 
virtual void NotifyConstructionCompleted (void)
 This method is invoked once all member attributes have been initialized. More...
 

Detailed Description

UAN Noise Model base class.

Config Paths

ns3::UanNoiseModel is accessible through the following paths with Config::Set and Config::Connect:

  • /ChannelList/[i]/$ns3::UanChannel/NoiseModel
  • /NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Channel/NoiseModel

No Attributes are defined for this type.
No TraceSources are defined for this type.

Definition at line 33 of file uan-noise-model.h.

Member Function Documentation

void ns3::UanNoiseModel::Clear ( void  )
virtual

Clear all pointer references.

Definition at line 35 of file uan-noise-model.cc.

Referenced by DoDispose().

+ Here is the caller graph for this function:

void ns3::UanNoiseModel::DoDispose ( void  )
virtual

This method is called by Object::Dispose or by the object's destructor, whichever comes first.

Subclasses are expected to implement their real destruction code in an overriden version of this method and chain up to their parent's implementation once they are done. i.e., for simplicity, the destructor of every subclass should be empty and its content should be moved to the associated DoDispose method.

It is safe to call GetObject from within this method.

Reimplemented from ns3::Object.

Definition at line 40 of file uan-noise-model.cc.

References Clear(), and ns3::Object::DoDispose().

+ Here is the call graph for this function:

virtual double ns3::UanNoiseModel::GetNoiseDbHz ( double  fKhz) const
pure virtual

Compute the noise power at a given frequency.

Parameters
fKhzFrequency in kHz.
Returns
Noise power in dB re 1uPa/Hz.

Implemented in ns3::UanNoiseModelDefault.

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

Register this type.

Returns
The TypeId.

Definition at line 27 of file uan-noise-model.cc.

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:


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