Base class for all RTT Estimators. More...
#include "rtt-estimator.h"
Public Member Functions | |
RttEstimator () | |
RttEstimator (const RttEstimator &r) | |
Copy constructor. | |
~RttEstimator () override | |
virtual Ptr< RttEstimator > | Copy () const =0 |
Copy object (including current internal state) | |
Time | GetEstimate () const |
gets the RTT estimate. | |
TypeId | GetInstanceTypeId () const override |
Get the most derived TypeId for this Object. | |
uint32_t | GetNSamples () const |
gets the number of samples used in the estimates | |
Time | GetVariation () const |
Note that this is not a formal statistical variance; it has the the same units as the estimate. | |
virtual void | Measurement (Time t)=0 |
Add a new measurement to the estimator. | |
virtual void | Reset () |
Resets the estimation to its initial state. | |
Public Member Functions inherited from ns3::Object | |
Object () | |
Constructor. | |
~Object () override | |
Destructor. | |
void | AggregateObject (Ptr< Object > other) |
Aggregate two Objects together. | |
void | Dispose () |
Dispose of this Object. | |
AggregateIterator | GetAggregateIterator () const |
Get an iterator to the Objects aggregated to this one. | |
TypeId | GetInstanceTypeId () const override |
Get the most derived TypeId for this Object. | |
template<typename T > | |
Ptr< T > | GetObject () const |
Get a pointer to the requested aggregated Object. | |
template<> | |
Ptr< Object > | GetObject () const |
Specialization of () for objects of type ns3::Object. | |
template<typename T > | |
Ptr< T > | GetObject (TypeId tid) const |
Get a pointer to the requested aggregated Object by TypeId. | |
template<> | |
Ptr< Object > | GetObject (TypeId tid) const |
Specialization of (TypeId tid) for objects of type ns3::Object. | |
void | Initialize () |
Invoke DoInitialize on all Objects aggregated to this one. | |
bool | IsInitialized () const |
Check if the object has been initialized. | |
Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter > | |
SimpleRefCount () | |
Default constructor. | |
SimpleRefCount (const SimpleRefCount &o) | |
Copy constructor. | |
uint32_t | GetReferenceCount () const |
Get the reference count of the object. | |
SimpleRefCount & | operator= (const SimpleRefCount &o) |
Assignment operator. | |
void | Ref () const |
Increment the reference count. | |
void | Unref () const |
Decrement the reference count. | |
Public Member Functions inherited from ns3::ObjectBase | |
virtual | ~ObjectBase () |
Virtual destructor. | |
void | GetAttribute (std::string name, AttributeValue &value) const |
Get the value of an attribute, raising fatal errors if unsuccessful. | |
bool | GetAttributeFailSafe (std::string name, AttributeValue &value) const |
Get the value of an attribute without raising errors. | |
virtual TypeId | GetInstanceTypeId () const =0 |
Get the most derived TypeId for this Object. | |
void | SetAttribute (std::string name, const AttributeValue &value) |
Set a single attribute, raising fatal errors if unsuccessful. | |
bool | SetAttributeFailSafe (std::string name, const AttributeValue &value) |
Set a single attribute without raising errors. | |
bool | TraceConnect (std::string name, std::string context, const CallbackBase &cb) |
Connect a TraceSource to a Callback with a context. | |
bool | TraceConnectWithoutContext (std::string name, const CallbackBase &cb) |
Connect a TraceSource to a Callback without a context. | |
bool | TraceDisconnect (std::string name, std::string context, const CallbackBase &cb) |
Disconnect from a TraceSource a Callback previously connected with a context. | |
bool | TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb) |
Disconnect from a TraceSource a Callback previously connected without a context. | |
Static Public Member Functions | |
static TypeId | GetTypeId () |
Get the type ID. | |
Static Public Member Functions inherited from ns3::Object | |
static TypeId | GetTypeId () |
Register this type. | |
Static Public Member Functions inherited from ns3::ObjectBase | |
static TypeId | GetTypeId () |
Get the type ID. | |
Protected Attributes | |
Time | m_estimatedRtt |
Current estimate. | |
Time | m_estimatedVariation |
Current estimate variation. | |
uint32_t | m_nSamples |
Number of samples. | |
Private Attributes | |
Time | m_initialEstimatedRtt |
Initial RTT estimation. | |
Additional Inherited Members | |
Protected Member Functions inherited from ns3::Object | |
Object (const Object &o) | |
Copy an Object. | |
virtual void | DoDispose () |
Destructor implementation. | |
virtual void | DoInitialize () |
Initialize() implementation. | |
virtual void | NotifyNewAggregate () |
Notify all Objects aggregated to this one of a new Object being aggregated. | |
Protected Member Functions inherited from ns3::ObjectBase | |
void | ConstructSelf (const AttributeConstructionList &attributes) |
Complete construction of ObjectBase; invoked by derived classes. | |
virtual void | NotifyConstructionCompleted () |
Notifier called once the ObjectBase is fully constructed. | |
Related Functions inherited from ns3::ObjectBase | |
static TypeId | GetObjectIid () |
Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. | |
Base class for all RTT Estimators.
Introspection did not find any typical Config paths.
The RTT Estimator class computes an estimate of the round trip time observed in a series of Time measurements. The estimate is provided in the form of an estimate and a sample variation. Subclasses can implement different algorithms to provide values for the estimate and variation.
Time
+9.22337e+18ns:+9.22337e+18ns No TraceSources are defined for this type.
Size of this type is 64 bytes (on a 64-bit architecture).
Definition at line 42 of file rtt-estimator.h.
ns3::RttEstimator::RttEstimator | ( | ) |
Definition at line 73 of file rtt-estimator.cc.
References ns3::ObjectBase::ConstructSelf(), ns3::Time::GetSeconds(), m_estimatedRtt, m_estimatedVariation, m_initialEstimatedRtt, NS_LOG_DEBUG, and NS_LOG_FUNCTION.
ns3::RttEstimator::RttEstimator | ( | const RttEstimator & | r | ) |
Copy constructor.
r | the object to copy |
Definition at line 86 of file rtt-estimator.cc.
References NS_LOG_FUNCTION.
|
override |
Definition at line 96 of file rtt-estimator.cc.
References NS_LOG_FUNCTION.
|
pure virtual |
Copy object (including current internal state)
Implemented in ns3::RttMeanDeviation.
Time ns3::RttEstimator::GetEstimate | ( | ) | const |
gets the RTT estimate.
Definition at line 60 of file rtt-estimator.cc.
References m_estimatedRtt.
|
overridevirtual |
Get the most derived TypeId for this Object.
This method is typically implemented by ns3::Object::GetInstanceTypeId but some classes which derive from ns3::ObjectBase directly have to implement it themselves.
Reimplemented from ns3::Object.
Reimplemented in ns3::RttMeanDeviation.
Definition at line 102 of file rtt-estimator.cc.
References GetTypeId().
uint32_t ns3::RttEstimator::GetNSamples | ( | ) | const |
gets the number of samples used in the estimates
Definition at line 118 of file rtt-estimator.cc.
References m_nSamples.
|
static |
Get the type ID.
Definition at line 46 of file rtt-estimator.cc.
References m_initialEstimatedRtt, ns3::MakeTimeAccessor(), ns3::MakeTimeChecker(), ns3::Seconds(), and ns3::TypeId::SetParent().
Referenced by GetInstanceTypeId().
Time ns3::RttEstimator::GetVariation | ( | ) | const |
Note that this is not a formal statistical variance; it has the the same units as the estimate.
Mean deviation or standard deviation are example quantities that could be provided here.
gets the RTT estimate variation.
Definition at line 66 of file rtt-estimator.cc.
References m_estimatedVariation.
|
pure virtual |
Add a new measurement to the estimator.
Pure virtual function.
t | the new RTT measure. |
Implemented in ns3::RttMeanDeviation.
|
virtual |
Resets the estimation to its initial state.
Reimplemented in ns3::RttMeanDeviation.
Definition at line 108 of file rtt-estimator.cc.
References m_estimatedRtt, m_estimatedVariation, m_initialEstimatedRtt, m_nSamples, and NS_LOG_FUNCTION.
Referenced by ns3::RttMeanDeviation::Reset().
|
protected |
Current estimate.
Definition at line 105 of file rtt-estimator.h.
Referenced by RttEstimator(), ns3::RttMeanDeviation::FloatingPointUpdate(), GetEstimate(), ns3::RttMeanDeviation::IntegerUpdate(), ns3::RttMeanDeviation::Measurement(), and Reset().
|
protected |
Current estimate variation.
Definition at line 106 of file rtt-estimator.h.
Referenced by RttEstimator(), ns3::RttMeanDeviation::FloatingPointUpdate(), GetVariation(), ns3::RttMeanDeviation::IntegerUpdate(), ns3::RttMeanDeviation::Measurement(), and Reset().
|
private |
Initial RTT estimation.
Definition at line 102 of file rtt-estimator.h.
Referenced by RttEstimator(), GetTypeId(), and Reset().
|
protected |
Number of samples.
Definition at line 107 of file rtt-estimator.h.
Referenced by GetNSamples(), ns3::RttMeanDeviation::Measurement(), and Reset().