A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | Static Public Member Functions | Private Member Functions | List of all members
ns3::PropagationDelayModel Class Reference
Propagation Models

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)
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)
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 Start (void)
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 SimpleRefCount (const SimpleRefCount &o)
uint32_t GetReferenceCount (void) const
SimpleRefCount & operator= (const SimpleRefCount &o)
void Ref (void) const
void Unref (void) const
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
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)
 This method returns the TypeId associated to ns3::PropagationDelayModel.

Private Member Functions

virtual int64_t DoAssignStreams (int64_t stream)=0

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
virtual void DoDispose (void)
virtual void DoStart (void)
virtual void NotifyNewAggregate (void)

Detailed Description

calculate a propagation delay.

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

Constructor & Destructor Documentation

ns3::PropagationDelayModel::~PropagationDelayModel ( )
virtual

Definition at line 39 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 44 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

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.

Referenced by ns3::YansWifiChannel::Send(), ns3::SingleModelSpectrumChannel::StartTx(), and ns3::MultiModelSpectrumChannel::StartTx().

+ Here is the caller graph for this function:

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

This method returns the TypeId associated to ns3::PropagationDelayModel.

This object is accessible through the following paths with Config::Set and Config::Connect:

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

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

Reimplemented from ns3::Object.

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

Definition at line 31 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: