Base class for antenna gain statistics helpers. More...
#include "satellite-stats-antenna-gain-helper.h"
Inheritance diagram for ns3::SatStatsAntennaGainHelper:
Collaboration diagram for ns3::SatStatsAntennaGainHelper:
Public Member Functions | |
| SatStatsAntennaGainHelper (Ptr< const SatHelper > satHelper) | |
| virtual | ~SatStatsAntennaGainHelper () |
| / Destructor. More... | |
| void | AntennaGainCallback (std::string identifier, double gain) |
| Receive inputs from trace sources. More... | |
| bool | GetAveragingMode () const |
| void | InstallProbes () |
| Set up several probes or other means of listeners and connect them to the collectors. More... | |
| void | SetAveragingMode (bool averagingMode) |
| Public Member Functions inherited from ns3::SatStatsHelper | |
| SatStatsHelper (Ptr< const SatHelper > satHelper) | |
| Creates a new helper instance. More... | |
| virtual | ~SatStatsHelper () |
| / Destructor. More... | |
| IdentifierType_t | GetIdentifierType () const |
| std::string | GetName () const |
| OutputType_t | GetOutputType () const |
| Ptr< const SatHelper > | GetSatHelper () const |
| void | Install () |
| Install the probes, collectors, and aggregators necessary to produce the statistics output. More... | |
| bool | IsInstalled () const |
| void | SetIdentifierType (IdentifierType_t identifierType) |
| void | SetName (std::string name) |
| void | SetOutputType (OutputType_t outputType) |
| virtual void | UpdateAddressAndIdentifier (Ptr< Node > utNode) |
| Update the address and the proper identifier from the given UT node. More... | |
| virtual void | UpdateIdentifierOnProbes () |
| Change identifier used on probes, when handovers occur. More... | |
Static Public Member Functions | |
| static TypeId | GetTypeId () |
| inherited from ObjectBase base class More... | |
| Static Public Member Functions inherited from ns3::SatStatsHelper | |
| static std::string | GetIdentifierTypeName (IdentifierType_t identifierType) |
| static std::string | GetOutputTypeName (OutputType_t outputType) |
| static TypeId | GetTypeId () |
| inherited from ObjectBase base class More... | |
Protected Member Functions | |
| void | DoInstall () |
| Install the probes, collectors, and aggregators necessary to produce the statistics output. More... | |
| Protected Member Functions inherited from ns3::SatStatsHelper | |
| Ptr< DataCollectionObject > | CreateAggregator (std::string aggregatorTypeId, std::string n1="", const AttributeValue &v1=EmptyAttributeValue(), std::string n2="", const AttributeValue &v2=EmptyAttributeValue(), std::string n3="", const AttributeValue &v3=EmptyAttributeValue(), std::string n4="", const AttributeValue &v4=EmptyAttributeValue(), std::string n5="", const AttributeValue &v5=EmptyAttributeValue()) |
| Create the aggregator according to the output type. More... | |
| uint32_t | CreateCollectorPerIdentifier (CollectorMap &collectorMap) const |
| Create one collector instance for each identifier in the simulation. More... | |
| virtual std::string | GetDistributionHeading (std::string dataLabel) const |
| uint32_t | GetGwId (Ptr< Node > gwNode) const |
| uint32_t | GetIdentifierForBeam (uint32_t satId, uint32_t beamId) const |
| uint32_t | GetIdentifierForGroup (uint32_t groupId) const |
| uint32_t | GetIdentifierForGw (Ptr< Node > gwNode) const |
| uint32_t | GetIdentifierForIsl (Ptr< Node > satNodeSrc, Ptr< Node > satNodeDst) const |
| uint32_t | GetIdentifierForSat (Ptr< Node > satNode) const |
| uint32_t | GetIdentifierForUt (Ptr< Node > utNode) const |
| uint32_t | GetIdentifierForUtUser (Ptr< Node > utUserNode) const |
| virtual std::string | GetIdentifierHeading (std::string dataLabel) const |
| virtual std::string | GetOutputFileName () const |
| Compute the path and file name where statistics output should be written to. More... | |
| virtual std::string | GetOutputPath () const |
| uint32_t | GetSatId (Ptr< Node > satNode) const |
| virtual std::string | GetTimeHeading (std::string dataLabel) const |
| uint32_t | GetUtId (Ptr< Node > utNode) const |
| uint32_t | GetUtUserId (Ptr< Node > utUserNode) const |
| virtual void | SaveAddressAndIdentifier (Ptr< Node > utNode) |
| Save the address and the proper identifier from the given UT node. More... | |
Protected Attributes | |
| Ptr< DataCollectionObject > | m_aggregator |
| The aggregator created by this helper. More... | |
| Ptr< DistributionCollector > | m_averagingCollector |
| The final collector utilized in averaged output (histogram, PDF, and CDF). More... | |
| CollectorMap | m_terminalCollectors |
| Maintains a list of collectors created by this helper. More... | |
| Protected Attributes inherited from ns3::SatStatsHelper | |
| std::map< const Address, uint32_t > | m_identifierMap |
| Map of address and the identifier associated with it. More... | |
Private Attributes | |
| bool | m_averagingMode |
AveragingMode attribute. More... | |
Additional Inherited Members | |
| Public Types inherited from ns3::SatStatsHelper | |
| enum | IdentifierType_t { IDENTIFIER_GLOBAL = 0 , IDENTIFIER_GW , IDENTIFIER_BEAM , IDENTIFIER_UT , IDENTIFIER_UT_USER , IDENTIFIER_SLICE , IDENTIFIER_GROUP , IDENTIFIER_SAT , IDENTIFIER_ISL } |
| Possible categorization of statistics output. More... | |
| enum | OutputType_t { OUTPUT_NONE = 0 , OUTPUT_SCALAR_FILE , OUTPUT_SCATTER_FILE , OUTPUT_HISTOGRAM_FILE , OUTPUT_PDF_FILE , OUTPUT_CDF_FILE , OUTPUT_SCALAR_PLOT , OUTPUT_SCATTER_PLOT , OUTPUT_HISTOGRAM_PLOT , OUTPUT_PDF_PLOT , OUTPUT_CDF_PLOT } |
| Possible types and formats of statistics output. More... | |
| Static Protected Member Functions inherited from ns3::SatStatsHelper | |
| static NetDeviceContainer | GetGwSatNetDevice (Ptr< Node > gwNode) |
| static Ptr< NetDevice > | GetSatSatOrbiterNetDevice (Ptr< Node > satNode) |
| static Ptr< NetDevice > | GetUtSatNetDevice (Ptr< Node > utNode) |
Detailed Description
Base class for antenna gain statistics helpers.
Definition at line 47 of file satellite-stats-antenna-gain-helper.h.
Constructor & Destructor Documentation
◆ SatStatsAntennaGainHelper()
| ns3::SatStatsAntennaGainHelper::SatStatsAntennaGainHelper | ( | Ptr< const SatHelper > | satHelper | ) |
Definition at line 52 of file satellite-stats-antenna-gain-helper.cc.
◆ ~SatStatsAntennaGainHelper()
|
virtual |
/ Destructor.
Definition at line 59 of file satellite-stats-antenna-gain-helper.cc.
Member Function Documentation
◆ AntennaGainCallback()
| void ns3::SatStatsAntennaGainHelper::AntennaGainCallback | ( | std::string | identifier, |
| double | gain | ||
| ) |
Receive inputs from trace sources.
- Parameters
-
identifier the source ID as a context string. gain the antenna gain collected.
Definition at line 95 of file satellite-stats-antenna-gain-helper.cc.
References ns3::SatStatsHelper::GetOutputType(), ns3::SatStatsHelper::GetOutputTypeName(), m_averagingMode, m_terminalCollectors, ns3::SatStatsHelper::OUTPUT_CDF_FILE, ns3::SatStatsHelper::OUTPUT_CDF_PLOT, ns3::SatStatsHelper::OUTPUT_HISTOGRAM_FILE, ns3::SatStatsHelper::OUTPUT_HISTOGRAM_PLOT, ns3::SatStatsHelper::OUTPUT_PDF_FILE, ns3::SatStatsHelper::OUTPUT_PDF_PLOT, ns3::SatStatsHelper::OUTPUT_SCALAR_FILE, ns3::SatStatsHelper::OUTPUT_SCALAR_PLOT, ns3::SatStatsHelper::OUTPUT_SCATTER_FILE, and ns3::SatStatsHelper::OUTPUT_SCATTER_PLOT.
Referenced by InstallProbes().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ DoInstall()
|
protectedvirtual |
Install the probes, collectors, and aggregators necessary to produce the statistics output.
An abstract method of SatStatsHelper which must be implemented by child classes. It will be invoked by Install().
- Todo:
- Add support for boxes in Gnuplot.
- Todo:
- Find a better dataset name.
- Todo:
- Find a better dataset name.
Implements ns3::SatStatsHelper.
Definition at line 153 of file satellite-stats-antenna-gain-helper.cc.
References ns3::SatStatsHelper::CreateAggregator(), ns3::SatStatsHelper::CreateCollectorPerIdentifier(), ns3::SatStatsHelper::GetDistributionHeading(), ns3::SatStatsHelper::GetIdentifierHeading(), ns3::SatStatsHelper::GetName(), ns3::SatStatsHelper::GetOutputFileName(), ns3::SatStatsHelper::GetOutputPath(), ns3::SatStatsHelper::GetOutputType(), ns3::SatStatsHelper::GetOutputTypeName(), ns3::SatStatsHelper::GetTimeHeading(), InstallProbes(), m_aggregator, m_averagingCollector, m_averagingMode, m_terminalCollectors, ns3::SatStatsHelper::OUTPUT_CDF_FILE, ns3::SatStatsHelper::OUTPUT_CDF_PLOT, ns3::SatStatsHelper::OUTPUT_HISTOGRAM_FILE, ns3::SatStatsHelper::OUTPUT_HISTOGRAM_PLOT, ns3::SatStatsHelper::OUTPUT_NONE, ns3::SatStatsHelper::OUTPUT_PDF_FILE, ns3::SatStatsHelper::OUTPUT_PDF_PLOT, ns3::SatStatsHelper::OUTPUT_SCALAR_FILE, ns3::SatStatsHelper::OUTPUT_SCALAR_PLOT, ns3::SatStatsHelper::OUTPUT_SCATTER_FILE, and ns3::SatStatsHelper::OUTPUT_SCATTER_PLOT.
Here is the call graph for this function:
◆ GetAveragingMode()
| bool ns3::SatStatsAntennaGainHelper::GetAveragingMode | ( | ) | const |
- Returns
- the currently active averaging mode.
Definition at line 88 of file satellite-stats-antenna-gain-helper.cc.
References m_averagingMode.
Referenced by GetTypeId().
Here is the caller graph for this function:
◆ GetTypeId()
|
static |
inherited from ObjectBase base class
Definition at line 65 of file satellite-stats-antenna-gain-helper.cc.
References GetAveragingMode(), and SetAveragingMode().
Here is the call graph for this function:
◆ InstallProbes()
| void ns3::SatStatsAntennaGainHelper::InstallProbes | ( | ) |
Set up several probes or other means of listeners and connect them to the collectors.
Definition at line 458 of file satellite-stats-antenna-gain-helper.cc.
References AntennaGainCallback(), and ns3::SatStatsHelper::GetIdentifierForUt().
Referenced by DoInstall().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ SetAveragingMode()
| void ns3::SatStatsAntennaGainHelper::SetAveragingMode | ( | bool | averagingMode | ) |
- Parameters
-
averagingMode average all samples before passing them to aggregator.
Definition at line 81 of file satellite-stats-antenna-gain-helper.cc.
References m_averagingMode.
Referenced by GetTypeId().
Here is the caller graph for this function:
Member Data Documentation
◆ m_aggregator
|
protected |
The aggregator created by this helper.
Definition at line 97 of file satellite-stats-antenna-gain-helper.h.
Referenced by DoInstall().
◆ m_averagingCollector
|
protected |
The final collector utilized in averaged output (histogram, PDF, and CDF).
Definition at line 94 of file satellite-stats-antenna-gain-helper.h.
Referenced by DoInstall().
◆ m_averagingMode
|
private |
AveragingMode attribute.
Definition at line 100 of file satellite-stats-antenna-gain-helper.h.
Referenced by AntennaGainCallback(), DoInstall(), GetAveragingMode(), and SetAveragingMode().
◆ m_terminalCollectors
|
protected |
Maintains a list of collectors created by this helper.
Definition at line 91 of file satellite-stats-antenna-gain-helper.h.
Referenced by AntennaGainCallback(), and DoInstall().
The documentation for this class was generated from the following files:
- /builds/sns3/satellite/satellite/stats/satellite-stats-antenna-gain-helper.h
- /builds/sns3/satellite/satellite/stats/satellite-stats-antenna-gain-helper.cc
