A Discrete-Event Network Simulator
API
ns3::ChannelCondition Class Reference

Carries information about the LOS/NLOS channel state. More...

#include "channel-condition-model.h"

+ Inheritance diagram for ns3::ChannelCondition:
+ Collaboration diagram for ns3::ChannelCondition:

Public Types

enum  LosConditionValue { LOS, NLOS }
 Possible values for Line-of-Sight condition. More...
 

Public Member Functions

 ChannelCondition ()
 Constructor for the ChannelCondition class. More...
 
virtual ~ChannelCondition ()
 Destructor for the ChannelCondition class. More...
 
LosConditionValue GetLosCondition () const
 Get the LosConditionValue contaning the information about the LOS/NLOS state of the channel. More...
 
void SetLosCondition (LosConditionValue losCondition)
 Set the LosConditionValue with the information about the LOS/NLOS state of the channel. More...
 
- Public Member Functions inherited from ns3::Object
 Object ()
 Constructor. More...
 
virtual ~Object ()
 Destructor. More...
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together. More...
 
void Dispose (void)
 Dispose of this Object. More...
 
AggregateIterator GetAggregateIterator (void) const
 Get an iterator to the Objects aggregated to this one. More...
 
virtual TypeId GetInstanceTypeId (void) const
 Get the most derived TypeId for this Object. More...
 
template<typename T >
Ptr< T > GetObject (void) const
 Get a pointer to the requested aggregated Object. More...
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId. More...
 
template<>
Ptr< ObjectGetObject () const
 
template<>
Ptr< ObjectGetObject (TypeId tid) const
 
void Initialize (void)
 Invoke DoInitialize on all Objects aggregated to this one. More...
 
bool IsInitialized (void) const
 Check if the object has been initialized. More...
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 Default 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 operator. 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
 Get the value of an attribute, raising fatal errors if unsuccessful. More...
 
bool GetAttributeFailSafe (std::string name, AttributeValue &value) const
 Get the value of an attribute without raising erros. More...
 
void SetAttribute (std::string name, const AttributeValue &value)
 Set a single attribute, raising fatal errors if unsuccessful. More...
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 Set a single attribute without raising errors. More...
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 Connect a TraceSource to a Callback with a context. More...
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 Connect a TraceSource to a Callback without a context. More...
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected with a context. More...
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected without a context. More...
 

Static Public Member Functions

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

Private Attributes

LosConditionValue m_losCondition
 contains the information about the LOS/NLOS state of the channel More...
 

Additional Inherited Members

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

Detailed Description

Carries information about the LOS/NLOS channel state.


Introspection did not find any typical Config paths.

Additional information about the channel condition can be aggregated to instances of this class.


No Attributes are defined for this type.
No TraceSources are defined for this type.
Size of this type is 32 bytes (on a 64-bit architecture).

Definition at line 41 of file channel-condition-model.h.

Member Enumeration Documentation

◆ LosConditionValue

Possible values for Line-of-Sight condition.

Enumerator
LOS 

Line of Sight.

NLOS 

Non Line of Sight.

Definition at line 48 of file channel-condition-model.h.

Constructor & Destructor Documentation

◆ ChannelCondition()

ns3::ChannelCondition::ChannelCondition ( )

Constructor for the ChannelCondition class.

Definition at line 44 of file channel-condition-model.cc.

◆ ~ChannelCondition()

ns3::ChannelCondition::~ChannelCondition ( )
virtual

Destructor for the ChannelCondition class.

Definition at line 48 of file channel-condition-model.cc.

Member Function Documentation

◆ GetLosCondition()

ChannelCondition::LosConditionValue ns3::ChannelCondition::GetLosCondition ( ) const

Get the LosConditionValue contaning the information about the LOS/NLOS state of the channel.

Returns
the LosConditionValue

Definition at line 53 of file channel-condition-model.cc.

References m_losCondition.

Referenced by BuildingsChannelConditionModelTestCase::DoRun(), and ThreeGppChannelConditionModelTestCase::EvaluateChannelCondition().

+ Here is the caller graph for this function:

◆ GetTypeId()

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

Get the type ID.

Get the type ID.

Returns
the object TypeId

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

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ SetLosCondition()

void ns3::ChannelCondition::SetLosCondition ( LosConditionValue  losCondition)

Set the LosConditionValue with the information about the LOS/NLOS state of the channel.

Parameters
theLosConditionValue

Definition at line 59 of file channel-condition-model.cc.

References m_losCondition.

Member Data Documentation

◆ m_losCondition

LosConditionValue ns3::ChannelCondition::m_losCondition
private

contains the information about the LOS/NLOS state of the channel

Definition at line 88 of file channel-condition-model.h.

Referenced by GetLosCondition(), and SetLosCondition().


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