A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
ns3::PropagationDelayModel Class Referenceabstract

calculate a propagation delay. More...

#include <propagation-delay-model.h>

+ Inheritance diagram for ns3::PropagationDelayModel:
+ Collaboration diagram for ns3::PropagationDelayModel:

Public Member Functions

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 ()
 
virtual ~Object ()
 
void AggregateObject (Ptr< Object > other)
 
void Dispose (void)
 Run the DoDispose methods of this object and all the objects aggregated to it. More...
 
AggregateIterator GetAggregateIterator (void) const
 
virtual TypeId GetInstanceTypeId (void) const
 
template<typename T >
Ptr< T > GetObject (void) const
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 
void Initialize (void)
 This method calls the virtual DoInitialize method on all the objects aggregated to this object. More...
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 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. 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
 
bool GetAttributeFailSafe (std::string name, AttributeValue &attribute) const
 
void SetAttribute (std::string name, const AttributeValue &value)
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 
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)
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId (void)
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void Cleanup (void)
 Noop. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 Get the type ID. More...
 

Private Member Functions

virtual int64_t DoAssignStreams (int64_t stream)=0
 Subclasses must implement this; those not using random variables can return zero. More...
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 
virtual void DoDispose (void)
 This method is called by Object::Dispose or by the object's destructor, whichever comes first. More...
 
virtual void DoInitialize (void)
 This method is called only once by Object::Initialize. More...
 
virtual void NotifyNewAggregate (void)
 This method is invoked whenever two sets of objects are aggregated together. More...
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 
virtual void NotifyConstructionCompleted (void)
 This method is invoked once all member attributes have been initialized. More...
 

Detailed Description

calculate a propagation delay.

Config Paths

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

  • /ChannelList/[i]/$ns3::WifiChannel/$ns3::YansWifiChannel/PropagationDelayModel
  • /ChannelList/[i]/$ns3::YansWifiChannel/PropagationDelayModel
  • /NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Channel/$ns3::YansWifiChannel/PropagationDelayModel

No Attributes are defined for this type.
No TraceSources are defined for this type.

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

Constructor & Destructor Documentation

ns3::PropagationDelayModel::~PropagationDelayModel ( )
virtual

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

Member Function Documentation

int64_t ns3::PropagationDelayModel::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'.

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

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

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

References DoAssignStreams().

+ Here is the call graph for this function:

virtual int64_t ns3::PropagationDelayModel::DoAssignStreams ( int64_t  stream)
privatepure virtual

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

Implemented in ns3::ConstantSpeedPropagationDelayModel, and ns3::RandomPropagationDelayModel.

Referenced by AssignStreams().

+ Here is the caller graph for this function:

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

Calculate the propagation delay between the specified source and destination.

Implemented in ns3::ConstantSpeedPropagationDelayModel, and ns3::RandomPropagationDelayModel.

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

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

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:


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