A Discrete-Event Network Simulator
API
ns3::ChannelConditionModel Class Referenceabstract

Models the channel condition. More...

#include "channel-condition-model.h"

+ Inheritance diagram for ns3::ChannelConditionModel:
+ Collaboration diagram for ns3::ChannelConditionModel:

Public Member Functions

 ChannelConditionModel ()
 Constructor for the ChannelConditionModel class. More...
 
 ChannelConditionModel (const ChannelConditionModel &)=delete
 Copy constructor. More...
 
virtual ~ChannelConditionModel ()
 Destructor for the ChannelConditionModel class. More...
 
virtual int64_t AssignStreams (int64_t stream)=0
 If this model uses objects of type RandomVariableStream, set the stream numbers to the integers starting with the offset 'stream'. More...
 
virtual Ptr< ChannelConditionGetChannelCondition (Ptr< const MobilityModel > a, Ptr< const MobilityModel > b) const =0
 Computes the condition of the channel between a and b. More...
 
ChannelConditionModeloperator= (const ChannelConditionModel &)=delete
 Copy constructor. 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<>
Ptr< ObjectGetObject () const
 Specialization of () for objects of type ns3::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 (TypeId tid) const
 Specialization of (TypeId tid) for objects of type ns3::Object. More...
 
template<typename T >
Ptr< T > GetObject (void) const
 Get a pointer to the requested aggregated Object. More...
 
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[[maybe_unused]])
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= ([[maybe_unused]] 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...
 

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

Models the channel condition.

Computes the condition of the channel between the transmitter and the receiver

Config Paths

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

  • "/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Channel/$ns3::SpectrumChannel/PropagationLossModel/$ns3::ThreeGppPropagationLossModel/ChannelConditionModel"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Channel/$ns3::YansWifiChannel/PropagationLossModel/$ns3::ThreeGppPropagationLossModel/ChannelConditionModel"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WaveNetDevice/Channel/$ns3::SpectrumChannel/PropagationLossModel/$ns3::ThreeGppPropagationLossModel/ChannelConditionModel"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WaveNetDevice/Channel/$ns3::YansWifiChannel/PropagationLossModel/$ns3::ThreeGppPropagationLossModel/ChannelConditionModel"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::LrWpanNetDevice/Channel/PropagationLossModel/$ns3::ThreeGppPropagationLossModel/ChannelConditionModel"
  • "/ChannelList/[i]/$ns3::SpectrumChannel/PropagationLossModel/$ns3::ThreeGppPropagationLossModel/ChannelConditionModel"
  • "/ChannelList/[i]/$ns3::YansWifiChannel/PropagationLossModel/$ns3::ThreeGppPropagationLossModel/ChannelConditionModel"

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 201 of file channel-condition-model.h.

Constructor & Destructor Documentation

◆ ChannelConditionModel() [1/2]

ns3::ChannelConditionModel::ChannelConditionModel ( )

Constructor for the ChannelConditionModel class.

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

◆ ~ChannelConditionModel()

ns3::ChannelConditionModel::~ChannelConditionModel ( )
virtual

Destructor for the ChannelConditionModel class.

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

◆ ChannelConditionModel() [2/2]

ns3::ChannelConditionModel::ChannelConditionModel ( const ChannelConditionModel )
delete

Copy constructor.

Defined and unimplemented to avoid misuse

Member Function Documentation

◆ AssignStreams()

virtual int64_t ns3::ChannelConditionModel::AssignStreams ( int64_t  stream)
pure virtual

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
streamthe offset used to set the stream numbers
Returns
the number of stream indices assigned by this model

Implemented in ns3::ThreeGppChannelConditionModel, ns3::NeverLosVehicleChannelConditionModel, ns3::NeverLosChannelConditionModel, ns3::AlwaysLosChannelConditionModel, and ns3::BuildingsChannelConditionModel.

◆ GetChannelCondition()

virtual Ptr<ChannelCondition> ns3::ChannelConditionModel::GetChannelCondition ( Ptr< const MobilityModel a,
Ptr< const MobilityModel b 
) const
pure virtual

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

Implemented in ns3::ThreeGppChannelConditionModel, ns3::NeverLosVehicleChannelConditionModel, ns3::NeverLosChannelConditionModel, ns3::AlwaysLosChannelConditionModel, and ns3::BuildingsChannelConditionModel.

◆ GetTypeId()

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

Get the type ID.

Get the type ID.

Returns
the object TypeId

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

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ operator=()

ChannelConditionModel& ns3::ChannelConditionModel::operator= ( const ChannelConditionModel )
delete

Copy constructor.

Defined and unimplemented to avoid misuse

Returns
the ChannelConditionModel instance

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