ns-3
ns3::RadioEnvironmentMapHelper Class Reference

#include <radio-environment-map-helper.h>

Inheritance diagram for ns3::RadioEnvironmentMapHelper:
Collaboration diagram for ns3::RadioEnvironmentMapHelper:

List of all members.

Classes

struct  RemPoint

Public Member Functions

virtual void DoDispose (void)
uint8_t GetBandwidth () const
void SetBandwidth (uint8_t bw)
void Install ()
- 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)
SimpleRefCountoperator= (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::RadioEnvironmentMapHelper.

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
virtual void NotifyNewAggregate (void)
virtual void DoStart (void)
 Object (const Object &o)

Detailed Description

Generates a 2D map of the SINR from the strongest transmitter in the downlink of an LTE FDD system.


Member Function Documentation

void ns3::RadioEnvironmentMapHelper::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.

References NS_LOG_FUNCTION.

uint8_t ns3::RadioEnvironmentMapHelper::GetBandwidth ( ) const
Returns:
the bandwidth (in num of RBs) over which SINR is calculated

Referenced by GetTypeId().

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

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

Attributes defined for this type:

  • ChannelPath: The path to the channel for which the Radio Environment Map is to be generated
    • Set with class: StringValue
    • Underlying type: std::string
    • Initial value: /ChannelList/0
    • Flags: construct write read
  • OutputFile: the filename to which the Radio Environment Map is saved
    • Set with class: StringValue
    • Underlying type: std::string
    • Initial value: rem.out
    • Flags: construct write read
  • XMin: The min x coordinate of the map.
    • Set with class: ns3::DoubleValue
    • Underlying type: double -1.79769e+308:1.79769e+308
    • Initial value: 0
    • Flags: construct write read
  • YMin: The min y coordinate of the map.
    • Set with class: ns3::DoubleValue
    • Underlying type: double -1.79769e+308:1.79769e+308
    • Initial value: 0
    • Flags: construct write read
  • XMax: The max x coordinate of the map.
    • Set with class: ns3::DoubleValue
    • Underlying type: double -1.79769e+308:1.79769e+308
    • Initial value: 1
    • Flags: construct write read
  • YMax: The max y coordinate of the map.
    • Set with class: ns3::DoubleValue
    • Underlying type: double -1.79769e+308:1.79769e+308
    • Initial value: 1
    • Flags: construct write read
  • XRes: The resolution (number of points) of the map along the x axis.
  • YRes: The resolution (number of points) of the map along the y axis.
  • Z: The value of the z coordinate for which the map is to be generated
    • Set with class: ns3::DoubleValue
    • Underlying type: double -1.79769e+308:1.79769e+308
    • Initial value: 0
    • Flags: construct write read
  • StopWhenDone: If true, Simulator::Stop () will be called as soon as the REM has been generated
    • Set with class: BooleanValue
    • Underlying type: bool
    • Initial value: true
    • Flags: construct write read
  • NoisePower: the power of the measuring instrument noise, in Watts. Default to a kT of -174 dBm with a noise figure of 9 dB and a bandwidth of 25 LTE Resource Blocks
    • Set with class: ns3::DoubleValue
    • Underlying type: double -1.79769e+308:1.79769e+308
    • Initial value: 1.423e-10
    • Flags: construct write read
  • MaxPointsPerIteration: Maximum number of REM points to be calculated per iteration. Every point consumes approximately 5KB of memory.
  • Earfcn: E-UTRA Absolute Radio Frequency Channel Number (EARFCN) as per 3GPP 36.101 Section 5.7.3.
  • Bandwidth: Transmission Bandwidth Configuration (in number of RBs) over which the SINR will be calculated

No TraceSources defined for this type.

Reimplemented from ns3::Object.

References GetBandwidth(), NS_LOG_FUNCTION, SetBandwidth(), and ns3::TypeId::SetParent().

void ns3::RadioEnvironmentMapHelper::Install ( )
void ns3::RadioEnvironmentMapHelper::SetBandwidth ( uint8_t  bw)
Parameters:
bwthe bandwidth (in num of RBs) over which SINR is calculated

References NS_FATAL_ERROR.

Referenced by GetTypeId().


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