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

the propagation speed is constant More...

#include "propagation-delay-model.h"

+ Inheritance diagram for ns3::ConstantSpeedPropagationDelayModel:
+ Collaboration diagram for ns3::ConstantSpeedPropagationDelayModel:

Public Member Functions

 ConstantSpeedPropagationDelayModel ()
 Use the default parameters from PropagationDelayConstantSpeed. More...
 
Time GetDelay (Ptr< MobilityModel > a, Ptr< MobilityModel > b) const override
 
double GetSpeed (void) const
 
void SetSpeed (double speed)
 
- Public Member Functions inherited from ns3::PropagationDelayModel
virtual ~PropagationDelayModel ()
 
int64_t AssignStreams (int64_t stream)
 If this delay model uses objects of type RandomVariableStream, set the stream numbers to the integers starting with the offset 'stream'. More...
 
virtual Time GetDelay (Ptr< MobilityModel > a, Ptr< MobilityModel > b) const =0
 
- 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)
 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...
 
virtual TypeId GetInstanceTypeId (void) const =0
 Get the most derived TypeId for this Object. 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::PropagationDelayModel
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 Member Functions

int64_t DoAssignStreams (int64_t stream) override
 Assign a fixed random variable stream number to the random variables used by this model. More...
 

Private Attributes

double m_speed
 speed More...
 

Additional Inherited Members

virtual int64_t DoAssignStreams (int64_t stream)=0
 Assign a fixed random variable stream number to the random variables used by this model. More...
 
- 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

the propagation speed is constant

Config Paths

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

  • "/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Channel/$ns3::YansWifiChannel/PropagationDelayModel/$ns3::ConstantSpeedPropagationDelayModel"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Phy/Channel/$ns3::YansWifiChannel/PropagationDelayModel/$ns3::ConstantSpeedPropagationDelayModel"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Phys/[i]/Channel/$ns3::YansWifiChannel/PropagationDelayModel/$ns3::ConstantSpeedPropagationDelayModel"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WaveNetDevice/Channel/$ns3::YansWifiChannel/PropagationDelayModel/$ns3::ConstantSpeedPropagationDelayModel"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WaveNetDevice/PhyEntities/[i]/Channel/$ns3::YansWifiChannel/PropagationDelayModel/$ns3::ConstantSpeedPropagationDelayModel"
  • "/ChannelList/[i]/$ns3::YansWifiChannel/PropagationDelayModel/$ns3::ConstantSpeedPropagationDelayModel"

Attributes

  • Speed: The propagation speed (m/s) in the propagation medium being considered. The default value is the propagation speed of light in the vacuum.
    • Set with class: ns3::DoubleValue
    • Underlying type: double -1.79769e+308:1.79769e+308
    • Initial value: 2.99792e+08
    • Flags: construct write read

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

Definition at line 108 of file propagation-delay-model.h.

Constructor & Destructor Documentation

◆ ConstantSpeedPropagationDelayModel()

ns3::ConstantSpeedPropagationDelayModel::ConstantSpeedPropagationDelayModel ( )

Use the default parameters from PropagationDelayConstantSpeed.

Definition at line 106 of file propagation-delay-model.cc.

Member Function Documentation

◆ DoAssignStreams()

int64_t ns3::ConstantSpeedPropagationDelayModel::DoAssignStreams ( int64_t  stream)
overrideprivatevirtual

Assign a fixed random variable stream number to the random variables used by this model.

Subclasses must implement this; those not using random variables can return zero.

Parameters
streamfirst stream index to use
Returns
the number of stream indices assigned by this model

Implements ns3::PropagationDelayModel.

Definition at line 128 of file propagation-delay-model.cc.

◆ GetDelay()

Time ns3::ConstantSpeedPropagationDelayModel::GetDelay ( Ptr< MobilityModel a,
Ptr< MobilityModel b 
) const
overridevirtual
Parameters
athe source
bthe destination
Returns
the calculated propagation delay

Calculate the propagation delay between the specified source and destination.

Implements ns3::PropagationDelayModel.

Definition at line 110 of file propagation-delay-model.cc.

References ns3::MobilityModel::GetDistanceFrom(), m_speed, and ns3::Seconds().

+ Here is the call graph for this function:

◆ GetSpeed()

double ns3::ConstantSpeedPropagationDelayModel::GetSpeed ( void  ) const
Returns
the current propagation speed (m/s).

Definition at line 122 of file propagation-delay-model.cc.

References m_speed.

◆ GetTypeId()

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

Get the type ID.

Returns
the object TypeId

Definition at line 92 of file propagation-delay-model.cc.

References m_speed, ns3::MakeDoubleAccessor(), and ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ SetSpeed()

void ns3::ConstantSpeedPropagationDelayModel::SetSpeed ( double  speed)
Parameters
speedthe new speed (m/s)

Definition at line 117 of file propagation-delay-model.cc.

References m_speed.

Member Data Documentation

◆ m_speed

double ns3::ConstantSpeedPropagationDelayModel::m_speed
private

speed

Definition at line 132 of file propagation-delay-model.h.

Referenced by GetDelay(), GetSpeed(), GetTypeId(), and SetSpeed().


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