A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
ns3::BuildingsChannelConditionModel Class Reference

Determines the channel condition based on the buildings deployed in the scenario. More...

#include "buildings-channel-condition-model.h"

+ Inheritance diagram for ns3::BuildingsChannelConditionModel:
+ Collaboration diagram for ns3::BuildingsChannelConditionModel:

Public Member Functions

 BuildingsChannelConditionModel ()
 Constructor for the BuildingsChannelConditionModel class.
 
 ~BuildingsChannelConditionModel () override
 Destructor for the BuildingsChannelConditionModel class.
 
int64_t AssignStreams (int64_t stream) override
 If this model uses objects of type RandomVariableStream, set the stream numbers to the integers starting with the offset 'stream'.
 
Ptr< ChannelConditionGetChannelCondition (Ptr< const MobilityModel > a, Ptr< const MobilityModel > b) const override
 Computes the condition of the channel between a and b.
 
- Public Member Functions inherited from ns3::ChannelConditionModel
 ChannelConditionModel ()
 Constructor for the ChannelConditionModel class.
 
 ChannelConditionModel (const ChannelConditionModel &)=delete
 
 ~ChannelConditionModel () override
 Destructor for the ChannelConditionModel class.
 
ChannelConditionModeloperator= (const ChannelConditionModel &)=delete
 
- Public Member Functions inherited from ns3::Object
 Object ()
 Constructor.
 
 ~Object () override
 Destructor.
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together.
 
void Dispose ()
 Dispose of this Object.
 
AggregateIterator GetAggregateIterator () const
 Get an iterator to the Objects aggregated to this one.
 
TypeId GetInstanceTypeId () const override
 Get the most derived TypeId for this Object.
 
template<typename T >
Ptr< T > GetObject () const
 Get a pointer to the requested aggregated Object.
 
template<>
Ptr< ObjectGetObject () const
 Specialization of () for objects of type ns3::Object.
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId.
 
template<>
Ptr< ObjectGetObject (TypeId tid) const
 Specialization of (TypeId tid) for objects of type ns3::Object.
 
void Initialize ()
 Invoke DoInitialize on all Objects aggregated to this one.
 
bool IsInitialized () const
 Check if the object has been initialized.
 
void UnidirectionalAggregateObject (Ptr< Object > other)
 Aggregate an Object to another Object.
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 Default constructor.
 
 SimpleRefCount (const SimpleRefCount &o)
 Copy constructor.
 
uint32_t GetReferenceCount () const
 Get the reference count of the object.
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 Assignment operator.
 
void Ref () const
 Increment the reference count.
 
void Unref () const
 Decrement the reference count.
 
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
 Virtual destructor.
 
void GetAttribute (std::string name, AttributeValue &value, bool permissive=false) const
 Get the value of an attribute, raising fatal errors if unsuccessful.
 
bool GetAttributeFailSafe (std::string name, AttributeValue &value) const
 Get the value of an attribute without raising errors.
 
void SetAttribute (std::string name, const AttributeValue &value)
 Set a single attribute, raising fatal errors if unsuccessful.
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 Set a single attribute without raising errors.
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 Connect a TraceSource to a Callback with a context.
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 Connect a TraceSource to a Callback without a context.
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected with a context.
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected without a context.
 

Static Public Member Functions

static TypeId GetTypeId ()
 Get the type ID.
 
- Static Public Member Functions inherited from ns3::ChannelConditionModel
static TypeId GetTypeId ()
 Get the type ID.
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId ()
 Register this type.
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId ()
 Get the type ID.
 

Private Member Functions

bool IsLineOfSightBlocked (const Vector &l1, const Vector &l2) const
 Checks if the line of sight between position l1 and position l2 is blocked by a building.
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object.
 
virtual void DoDispose ()
 Destructor implementation.
 
virtual void DoInitialize ()
 Initialize() implementation.
 
virtual void NotifyNewAggregate ()
 Notify all Objects aggregated to this one of a new Object being aggregated.
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 Complete construction of ObjectBase; invoked by derived classes.
 
virtual void NotifyConstructionCompleted ()
 Notifier called once the ObjectBase is fully constructed.
 

Detailed Description

Determines the channel condition based on the buildings deployed in the scenario.

Code adapted from MmWave3gppBuildingsPropagationLossModel

Definition at line 29 of file buildings-channel-condition-model.h.

Constructor & Destructor Documentation

◆ BuildingsChannelConditionModel()

ns3::BuildingsChannelConditionModel::BuildingsChannelConditionModel ( )

Constructor for the BuildingsChannelConditionModel class.

Definition at line 35 of file buildings-channel-condition-model.cc.

◆ ~BuildingsChannelConditionModel()

ns3::BuildingsChannelConditionModel::~BuildingsChannelConditionModel ( )
override

Destructor for the BuildingsChannelConditionModel class.

Definition at line 40 of file buildings-channel-condition-model.cc.

Member Function Documentation

◆ AssignStreams()

int64_t ns3::BuildingsChannelConditionModel::AssignStreams ( int64_t stream)
overridevirtual

If this model uses objects of type RandomVariableStream, set the stream numbers to the integers starting with the offset 'stream'.

Return the number of streams (possibly zero) that have been assigned.

Parameters
stream
Returns
the number of stream indices assigned by this model

Implements ns3::ChannelConditionModel.

Definition at line 179 of file buildings-channel-condition-model.cc.

◆ GetChannelCondition()

Ptr< ChannelCondition > ns3::BuildingsChannelConditionModel::GetChannelCondition ( Ptr< const MobilityModel > a,
Ptr< const MobilityModel > b ) const
overridevirtual

Computes the condition of the channel between a and b.

Parameters
amobility model
bmobility model
Returns
the condition of the channel between a and b

Implements ns3::ChannelConditionModel.

Definition at line 45 of file buildings-channel-condition-model.cc.

References ns3::Building::ConcreteWithWindows, ns3::CreateObject(), ns3::ChannelCondition::HIGH, ns3::ChannelCondition::I2I, IsLineOfSightBlocked(), ns3::ChannelCondition::LOS, ns3::ChannelCondition::LOW, ns3::ChannelCondition::NLOS, NS_ASSERT_MSG, NS_LOG_DEBUG, NS_LOG_FUNCTION, ns3::ChannelCondition::O2I, ns3::ChannelCondition::O2O, and ns3::Building::Wood.

+ Here is the call graph for this function:

◆ GetTypeId()

TypeId ns3::BuildingsChannelConditionModel::GetTypeId ( )
static

Get the type ID.

Get the type ID.

Returns
the object TypeId

Definition at line 26 of file buildings-channel-condition-model.cc.

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ IsLineOfSightBlocked()

bool ns3::BuildingsChannelConditionModel::IsLineOfSightBlocked ( const Vector & l1,
const Vector & l2 ) const
private

Checks if the line of sight between position l1 and position l2 is blocked by a building.

Parameters
l1position
l2position
Returns
true if the line of sight is blocked, false otherwise

Definition at line 160 of file buildings-channel-condition-model.cc.

References ns3::BuildingList::Begin(), and ns3::BuildingList::End().

Referenced by GetChannelCondition().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

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