Loading...
Searching...
No Matches
ns3::SatEnvVariables Class Reference

Class for environmental variables. More...

#include "satellite-env-variables.h"

Inheritance diagram for ns3::SatEnvVariables:
Collaboration diagram for ns3::SatEnvVariables:

Public Member Functions

 SatEnvVariables ()
 Constructor.
 ~SatEnvVariables ()
 Destructor.
void CreateDirectory (std::string path)
 Function for creating a directory.
void DoDispose ()
 Reset class NOTICE: this function is meant to me used only in test cases, where issues with singletons might arise.
void DoInitialize ()
 Initialize class NOTICE: this function is meant to me used only in test cases, where issues with singletons might arise.
std::string GetCurrentDateAndTime ()
 Returns current real world date and time.
std::string GetCurrentWorkingDirectory ()
 Function for getting the path to current working directory.
std::string GetDataPath ()
 Function for locating the data folder.
std::string GetOutputPath ()
 Function for getting the simulation folder.
std::string GetPathToExecutable ()
 Function for getting the path to executable.
bool IsValidDirectory (std::string path)
 Function for checking if the directory exists.
bool IsValidFile (std::string pathToFile)
 Function for checking if the file exists.
std::string LocateDataDirectory ()
 Function for locating the data directory within the NS-3 simulator folder.
std::string LocateDirectory (std::string initialPath)
 Function for locating a specific directory within the NS-3 simulator folder.
std::string LocateFile (std::string initialPath)
 Function for locating a specific file within the NS-3 simulator folder.
virtual void NotifyConstructionCompleted () override
 Notifier called once the ObjectBase is fully constructed.
void SetCurrentWorkingDirectory (std::string currentWorkingDirectory)
 Function for setting the path to current working directory.
void SetOutputPath (std::string outputPath)
 Method for setting the simulation output path.
void SetOutputVariables (std::string campaignName, std::string simTag, bool enableOutputOverwrite)
 Function for setting the output variables.
void SetPathToExecutable (std::string pathToExecutable)
 Function for setting the path to executable.

Static Public Member Functions

static Ptr< SatEnvVariables > GetInstance ()
static TypeId GetTypeId (void)
 NS-3 function for type id.

Private Member Functions

std::string AddToPath (std::string path, std::string stringToAdd)
 Function for forming the next level of a path.
void DumpRevisionDiff (std::string dataPath)
void DumpSimulationInformation ()
 Function for outputting the most essential simulation specific environmental information.
void ExecuteCommandAndReadOutput (std::string command, Ptr< SatOutputFileStreamStringContainer > outputContainer)
 Function for executing the command and inserting the output into a string container.
std::string FormOutputPath (std::string simRootPath, std::string campaignName, std::string simTag, std::string safetyTag)
 Function for forming the output path.
std::string InitializeOutputFolders (std::string campaignName, std::string simTag, bool enableOutputOverwrite)
 Function for forming the output path and directory structure.

Private Attributes

std::string m_campaignName
 Simulation campaign name.
std::string m_currentWorkingDirectory
 Path to current working directory.
std::string m_currentWorkingDirectoryFromAttribute
 Path to current working directory (attribute value).
std::string m_dataPath
 Default data path.
bool m_enableOutputOverwrite
 Enable simulation output overwrite.
bool m_enableSimInfoDiffOutput
 Is simulation information diff output enabled.
bool m_enableSimInfoOutput
 Is simulation information output enabled.
bool m_excludeDataFolderFromDiff
 Is data folder excluded from the simulation information diff.
bool m_isInitialized
 Flag for disposing and initializing.
bool m_isOutputPathInitialized
 Is output path initialized.
uint32_t m_levelsToCheck
 How many directory levels to check for data path.
std::string m_outputPath
 Result output path.
std::string m_pathToExecutable
 Path to executable.
std::string m_pathToExecutableFromAttribute
 Path to executable (attribute value).
std::string m_simRootPath
 Path to the simulation output root folder.
std::string m_simTag
 Tag related to the current simulation.

Static Private Attributes

static Ptr< SatEnvVariables > m_instance = nullptr
 Instance of SatEnvVariables used for singleton template.

Detailed Description

Class for environmental variables.

The class is used for storing information on environmental variables, e.g., the current working directory and path to data folder. The class implements functionality for locating directories within the NS-3 simulator folder. Certain variables can be overwritten with attributes.

Definition at line 43 of file satellite-env-variables.h.

Constructor & Destructor Documentation

◆ SatEnvVariables()

ns3::SatEnvVariables::SatEnvVariables ( )

Constructor.

Definition at line 103 of file satellite-env-variables.cc.

References m_campaignName, m_currentWorkingDirectory, m_currentWorkingDirectoryFromAttribute, m_dataPath, m_enableOutputOverwrite, m_enableSimInfoDiffOutput, m_enableSimInfoOutput, m_excludeDataFolderFromDiff, m_isInitialized, m_isOutputPathInitialized, m_levelsToCheck, m_outputPath, m_pathToExecutable, m_pathToExecutableFromAttribute, m_simRootPath, and m_simTag.

◆ ~SatEnvVariables()

ns3::SatEnvVariables::~SatEnvVariables ( )

Destructor.

Definition at line 281 of file satellite-env-variables.cc.

Member Function Documentation

◆ AddToPath()

std::string ns3::SatEnvVariables::AddToPath ( std::string path,
std::string stringToAdd )
private

Function for forming the next level of a path.

Parameters
pathpath
stringToAddstring to be added to the path
Returns
combined path

Definition at line 542 of file satellite-env-variables.cc.

Referenced by FormOutputPath(), and InitializeOutputFolders().

Here is the caller graph for this function:

◆ CreateDirectory()

void ns3::SatEnvVariables::CreateDirectory ( std::string path)

Function for creating a directory.

Parameters
pathpath to the directory to be created

Definition at line 564 of file satellite-env-variables.cc.

Referenced by InitializeOutputFolders().

Here is the caller graph for this function:

◆ DoDispose()

void ns3::SatEnvVariables::DoDispose ( )

Reset class NOTICE: this function is meant to me used only in test cases, where issues with singletons might arise.

Definition at line 217 of file satellite-env-variables.cc.

References m_currentWorkingDirectory, m_isInitialized, m_isOutputPathInitialized, and m_pathToExecutable.

◆ DoInitialize()

void ns3::SatEnvVariables::DoInitialize ( )

Initialize class NOTICE: this function is meant to me used only in test cases, where issues with singletons might arise.

Definition at line 145 of file satellite-env-variables.cc.

References DumpSimulationInformation(), InitializeOutputFolders(), IsValidDirectory(), LocateDataDirectory(), m_campaignName, m_currentWorkingDirectory, m_enableOutputOverwrite, m_enableSimInfoOutput, m_isInitialized, m_isOutputPathInitialized, m_pathToExecutable, and m_simTag.

Here is the call graph for this function:

◆ DumpRevisionDiff()

void ns3::SatEnvVariables::DumpRevisionDiff ( std::string dataPath)
private
Parameters
dataPath

Definition at line 649 of file satellite-env-variables.cc.

References ExecuteCommandAndReadOutput(), m_dataPath, and m_excludeDataFolderFromDiff.

Referenced by DumpSimulationInformation().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ DumpSimulationInformation()

void ns3::SatEnvVariables::DumpSimulationInformation ( )
private

Function for outputting the most essential simulation specific environmental information.

Definition at line 620 of file satellite-env-variables.cc.

References DumpRevisionDiff(), ExecuteCommandAndReadOutput(), GetCurrentDateAndTime(), LocateDirectory(), m_enableSimInfoDiffOutput, and m_outputPath.

Referenced by DoInitialize().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ExecuteCommandAndReadOutput()

void ns3::SatEnvVariables::ExecuteCommandAndReadOutput ( std::string command,
Ptr< SatOutputFileStreamStringContainer > outputContainer )
private

Function for executing the command and inserting the output into a string container.

Parameters
commandcommand to be executed
outputContainerpointer to output container

Definition at line 594 of file satellite-env-variables.cc.

Referenced by DumpRevisionDiff(), and DumpSimulationInformation().

Here is the caller graph for this function:

◆ FormOutputPath()

std::string ns3::SatEnvVariables::FormOutputPath ( std::string simRootPath,
std::string campaignName,
std::string simTag,
std::string safetyTag )
private

Function for forming the output path.

Parameters
simRootPathsimulation output root path
campaignNamesimulation campaign name
simTagsimulation tag
safetyTagsafety tag for avoiding overwrites
Returns
path to the created folder

Definition at line 515 of file satellite-env-variables.cc.

References AddToPath().

Referenced by InitializeOutputFolders().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GetCurrentDateAndTime()

std::string ns3::SatEnvVariables::GetCurrentDateAndTime ( )

Returns current real world date and time.

Returns
date and time as a string

Definition at line 574 of file satellite-env-variables.cc.

Referenced by DumpSimulationInformation().

Here is the caller graph for this function:

◆ GetCurrentWorkingDirectory()

std::string ns3::SatEnvVariables::GetCurrentWorkingDirectory ( )

Function for getting the path to current working directory.

Returns
path to current working directory

Definition at line 289 of file satellite-env-variables.cc.

References m_currentWorkingDirectory, and m_currentWorkingDirectoryFromAttribute.

◆ GetDataPath()

std::string ns3::SatEnvVariables::GetDataPath ( )
inline

Function for locating the data folder.

Returns
path to data folder

Definition at line 108 of file satellite-env-variables.h.

References m_dataPath.

Referenced by LocateDataDirectory().

Here is the caller graph for this function:

◆ GetInstance()

Ptr< SatEnvVariables > ns3::SatEnvVariables::GetInstance ( )
static

Definition at line 135 of file satellite-env-variables.cc.

References m_instance.

Referenced by ns3::SatAntennaGainPatternContainer::SatAntennaGainPatternContainer(), SatFrameAllocatorTestCase::SatFrameAllocatorTestCase(), ns3::SatFwdLinkChannelEstimationErrorContainer::SatFwdLinkChannelEstimationErrorContainer(), ns3::SatHelper::SatHelper(), ns3::SatLinkResults::SatLinkResults(), ns3::SatLinkResultsPlot::SatLinkResultsPlot(), ns3::SatRtnLinkChannelEstimationErrorContainer::SatRtnLinkChannelEstimationErrorContainer(), ns3::SatWaveformConf::SatWaveformConf(), ns3::SatCompositeSinrOutputTraceContainer::AddNode(), ns3::SatFadingInputTraceContainer::AddNode(), ns3::SatFadingOutputTraceContainer::AddNode(), ns3::SatInterferenceInputTraceContainer::AddNode(), ns3::SatInterferenceOutputTraceContainer::AddNode(), ns3::SatRxCnoInputTraceContainer::AddNode(), ns3::SatRxPowerInputTraceContainer::AddNode(), ns3::SatRxPowerOutputTraceContainer::AddNode(), ns3::SatLog::CreateLog(), ns3::SimulationHelper::CreateSatScenario(), GeoCoordinateTestCase::DoRun(), Pm1::DoRun(), SatAntennaPatternTestCase::DoRun(), SatBaseTestCase::DoRun(), SatBasicEstimatorAverageTestCase::DoRun(), SatBasicEstimatorLastTestCase::DoRun(), SatBasicEstimatorMinTestCase::DoRun(), SatConstantInterferenceTestCase::DoRun(), SatConstellationTest1::DoRun(), SatConstellationTest2::DoRun(), SatConstellationTest3::DoRun(), SatConstellationTest4::DoRun(), SatCraTest1::DoRun(), SatCrdsaTest1::DoRun(), SatCtrlMsgContDelOffTestCase::DoRun(), SatCtrlMsgContDelOnTestCase::DoRun(), SatDvbRcs2WaveformTableTestCase::DoRun(), SatDvbS2BbFrameConfTestCase::DoRun(), SatFadingExternalInputTraceTestCase::DoRun(), SatFrameAllocatorTestCase::DoRun(), SatFreeSpaceLossTestCase::DoRun(), SatFwdArqTestCase::DoRun(), SatFwdChannelEstimationErrorTestCase::DoRun(), SatGseTestCase::DoRun(), SatHandoverTest1::DoRun(), SatHandoverTest2::DoRun(), SatLoraCbrTestCase::DoRun(), SatLoraConstellationFirstWindowTestCase::DoRun(), SatLoraConstellationHandoverTestCase::DoRun(), SatLoraFirstWindowTestCase::DoRun(), SatLoraOutOfWindowWindowNoRetransmissionTestCase::DoRun(), SatLoraOutOfWindowWindowTestCase::DoRun(), SatLoraRegenerativeCbrTestCase::DoRun(), SatLoraRegenerativeFirstWindowTestCase::DoRun(), SatLoraRegenerativeOutOfWindowWindowNoRetransmissionTestCase::DoRun(), SatLoraRegenerativeOutOfWindowWindowTestCase::DoRun(), SatLoraRegenerativeSecondWindowTestCase::DoRun(), SatLoraSecondWindowTestCase::DoRun(), SatMobilityList1TestCase::DoRun(), SatMobilityList2TestCase::DoRun(), SatMobilityObserverTestCase::DoRun(), SatMobilityRandomTestCase::DoRun(), SatNcrTest1::DoRun(), SatNcrTest2::DoRun(), SatNcrTest3::DoRun(), SatPeriodicControlMessageTest1::DoRun(), SatPerPacketFwdLinkFullTestCase::DoRun(), SatPerPacketFwdLinkUserTestCase::DoRun(), SatPerPacketInterferenceTestCase::DoRun(), SatPerPacketRtnLinkFullTestCase::DoRun(), SatPerPacketRtnLinkUserTestCase::DoRun(), SatRegenerationTest1::DoRun(), SatRegenerationTest2::DoRun(), SatRegenerationTest3::DoRun(), SatRegenerationTest4::DoRun(), SatRegenerationTest5::DoRun(), SatRegenerationTest6::DoRun(), SatRegenerationTest7::DoRun(), SatRegenerationTest8::DoRun(), SatRleTestCase::DoRun(), SatRtnArqTestCase::DoRun(), SatRtnChannelEstimationErrorTestCase::DoRun(), SatSeqNoTestCase::DoRun(), SatSlottedAlohaTest1::DoRun(), ScenarioCreationFull::DoRun(), ScenarioCreationLarger::DoRun(), ScenarioCreationSimple::DoRun(), ScenarioCreationUser::DoRun(), SimpleUnicast1::DoRun(), SimpleUnicast2::DoRun(), SimpleUnicast3::DoRun(), SimpleUnicast4::DoRun(), SimpleUnicast5::DoRun(), SimpleUnicast6::DoRun(), SimpleUnicast7::DoRun(), SimpleUnicast8::DoRun(), ns3::SatHelper::EnableCreationTraces(), ns3::SatStatsHelper::GetOutputPath(), ns3::SimulationHelperConf::GetTypeId(), ns3::SatHelper::LoadConstellationTopology(), ns3::SatHelper::LoadMobileUtFromFile(), ns3::SatHelper::LoadMobileUtFromFile(), ns3::SatHelper::LoadMobileUTsFromFolder(), ns3::SimulationHelper::LoadScenario(), ns3::SatFadingExternalInputTraceContainer::NotifyConstructionCompleted(), ns3::SatHelper::NotifyConstructionCompleted(), ns3::SatPacketTrace::NotifyConstructionCompleted(), ns3::SimulationHelper::SetupOutputPath(), and ns3::SimulationHelper::StoreAttributesToFile().

◆ GetOutputPath()

std::string ns3::SatEnvVariables::GetOutputPath ( )

Function for getting the simulation folder.

Returns
path to the simulation folder

Definition at line 247 of file satellite-env-variables.cc.

References InitializeOutputFolders(), m_campaignName, m_enableOutputOverwrite, m_isOutputPathInitialized, m_outputPath, and m_simTag.

Here is the call graph for this function:

◆ GetPathToExecutable()

std::string ns3::SatEnvVariables::GetPathToExecutable ( )

Function for getting the path to executable.

Returns
path to executable

Definition at line 310 of file satellite-env-variables.cc.

References m_pathToExecutable, and m_pathToExecutableFromAttribute.

◆ GetTypeId()

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

NS-3 function for type id.

Returns
type id

Definition at line 48 of file satellite-env-variables.cc.

References m_campaignName, m_currentWorkingDirectoryFromAttribute, m_dataPath, m_enableOutputOverwrite, m_enableSimInfoDiffOutput, m_enableSimInfoOutput, m_excludeDataFolderFromDiff, m_pathToExecutableFromAttribute, and m_simTag.

◆ InitializeOutputFolders()

std::string ns3::SatEnvVariables::InitializeOutputFolders ( std::string campaignName,
std::string simTag,
bool enableOutputOverwrite )
private

Function for forming the output path and directory structure.

Parameters
campaignNamesimulation campaign name
simTagsimulation tag
enableOutputOverwriteis simulation output overwrite enabled
Returns
path to the created folder

Definition at line 454 of file satellite-env-variables.cc.

References AddToPath(), CreateDirectory(), FormOutputPath(), IsValidDirectory(), LocateDirectory(), m_isOutputPathInitialized, m_outputPath, and m_simRootPath.

Referenced by DoInitialize(), GetOutputPath(), and SetOutputVariables().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ IsValidDirectory()

bool ns3::SatEnvVariables::IsValidDirectory ( std::string path)

Function for checking if the directory exists.

Returns
does the directory exist

Definition at line 330 of file satellite-env-variables.cc.

Referenced by DoInitialize(), InitializeOutputFolders(), LocateDirectory(), and SetOutputPath().

Here is the caller graph for this function:

◆ IsValidFile()

bool ns3::SatEnvVariables::IsValidFile ( std::string pathToFile)

Function for checking if the file exists.

Returns
does the file exist

Definition at line 351 of file satellite-env-variables.cc.

Referenced by LocateFile().

Here is the caller graph for this function:

◆ LocateDataDirectory()

std::string ns3::SatEnvVariables::LocateDataDirectory ( )

Function for locating the data directory within the NS-3 simulator folder.

Returns
path to the data directory

Definition at line 364 of file satellite-env-variables.cc.

References GetDataPath(), and LocateDirectory().

Referenced by DoInitialize().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ LocateDirectory()

std::string ns3::SatEnvVariables::LocateDirectory ( std::string initialPath)

Function for locating a specific directory within the NS-3 simulator folder.

Parameters
initialPathinitial search path
Returns
path to the located directory

Definition at line 372 of file satellite-env-variables.cc.

References IsValidDirectory(), and m_levelsToCheck.

Referenced by DumpSimulationInformation(), InitializeOutputFolders(), and LocateDataDirectory().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ LocateFile()

std::string ns3::SatEnvVariables::LocateFile ( std::string initialPath)

Function for locating a specific file within the NS-3 simulator folder.

Parameters
initialPathinitial search path for the file
Returns
path to the located file

Definition at line 413 of file satellite-env-variables.cc.

References IsValidFile(), and m_levelsToCheck.

Here is the call graph for this function:

◆ NotifyConstructionCompleted()

void ns3::SatEnvVariables::NotifyConstructionCompleted ( )
overridevirtual

Notifier called once the ObjectBase is fully constructed.

This method is invoked once all member attributes have been initialized. Subclasses can override this method to be notified of this event but if they do this, they must chain up to their parent's NotifyConstructionCompleted method.

Definition at line 125 of file satellite-env-variables.cc.

◆ SetCurrentWorkingDirectory()

void ns3::SatEnvVariables::SetCurrentWorkingDirectory ( std::string currentWorkingDirectory)

Function for setting the path to current working directory.

Parameters
currentWorkingDirectorypath to current working directory

Definition at line 231 of file satellite-env-variables.cc.

References m_currentWorkingDirectory.

◆ SetOutputPath()

void ns3::SatEnvVariables::SetOutputPath ( std::string outputPath)

Method for setting the simulation output path.

The path must exist.

Parameters
outputPathThe new output path.

Definition at line 260 of file satellite-env-variables.cc.

References IsValidDirectory(), m_isOutputPathInitialized, and m_outputPath.

Here is the call graph for this function:

◆ SetOutputVariables()

void ns3::SatEnvVariables::SetOutputVariables ( std::string campaignName,
std::string simTag,
bool enableOutputOverwrite )

Function for setting the output variables.

The function also creates the output folder based on the new variables. NOTICE: this function is meant to me used only in test cases, where issues with singletons might arise. In any other case the class attributes should be used instead.

Parameters
campaignNamesimulation campaign name
simTagsimulation tag
enableOutputOverwriteis simulation output overwrite enabled

Definition at line 268 of file satellite-env-variables.cc.

References InitializeOutputFolders(), m_campaignName, m_enableOutputOverwrite, and m_simTag.

Here is the call graph for this function:

◆ SetPathToExecutable()

void ns3::SatEnvVariables::SetPathToExecutable ( std::string pathToExecutable)

Function for setting the path to executable.

Parameters
pathToExecutablepath to executable

Definition at line 239 of file satellite-env-variables.cc.

References m_pathToExecutable.

Member Data Documentation

◆ m_campaignName

std::string ns3::SatEnvVariables::m_campaignName
private

Simulation campaign name.

Affects the simulation output folder.

Definition at line 279 of file satellite-env-variables.h.

Referenced by SatEnvVariables(), DoInitialize(), GetOutputPath(), GetTypeId(), and SetOutputVariables().

◆ m_currentWorkingDirectory

std::string ns3::SatEnvVariables::m_currentWorkingDirectory
private

Path to current working directory.

Definition at line 244 of file satellite-env-variables.h.

Referenced by SatEnvVariables(), DoDispose(), DoInitialize(), GetCurrentWorkingDirectory(), and SetCurrentWorkingDirectory().

◆ m_currentWorkingDirectoryFromAttribute

std::string ns3::SatEnvVariables::m_currentWorkingDirectoryFromAttribute
private

Path to current working directory (attribute value).

Definition at line 254 of file satellite-env-variables.h.

Referenced by SatEnvVariables(), GetCurrentWorkingDirectory(), and GetTypeId().

◆ m_dataPath

std::string ns3::SatEnvVariables::m_dataPath
private

Default data path.

Definition at line 269 of file satellite-env-variables.h.

Referenced by SatEnvVariables(), DumpRevisionDiff(), GetDataPath(), and GetTypeId().

◆ m_enableOutputOverwrite

bool ns3::SatEnvVariables::m_enableOutputOverwrite
private

Enable simulation output overwrite.

Definition at line 294 of file satellite-env-variables.h.

Referenced by SatEnvVariables(), DoInitialize(), GetOutputPath(), GetTypeId(), and SetOutputVariables().

◆ m_enableSimInfoDiffOutput

bool ns3::SatEnvVariables::m_enableSimInfoDiffOutput
private

Is simulation information diff output enabled.

Definition at line 309 of file satellite-env-variables.h.

Referenced by SatEnvVariables(), DumpSimulationInformation(), and GetTypeId().

◆ m_enableSimInfoOutput

bool ns3::SatEnvVariables::m_enableSimInfoOutput
private

Is simulation information output enabled.

Definition at line 304 of file satellite-env-variables.h.

Referenced by SatEnvVariables(), DoInitialize(), and GetTypeId().

◆ m_excludeDataFolderFromDiff

bool ns3::SatEnvVariables::m_excludeDataFolderFromDiff
private

Is data folder excluded from the simulation information diff.

Definition at line 314 of file satellite-env-variables.h.

Referenced by SatEnvVariables(), DumpRevisionDiff(), and GetTypeId().

◆ m_instance

Ptr< SatEnvVariables > ns3::SatEnvVariables::m_instance = nullptr
staticprivate

Instance of SatEnvVariables used for singleton template.

Definition at line 324 of file satellite-env-variables.h.

Referenced by GetInstance().

◆ m_isInitialized

bool ns3::SatEnvVariables::m_isInitialized
private

Flag for disposing and initializing.

Definition at line 319 of file satellite-env-variables.h.

Referenced by SatEnvVariables(), DoDispose(), and DoInitialize().

◆ m_isOutputPathInitialized

bool ns3::SatEnvVariables::m_isOutputPathInitialized
private

Is output path initialized.

Definition at line 299 of file satellite-env-variables.h.

Referenced by SatEnvVariables(), DoDispose(), DoInitialize(), GetOutputPath(), InitializeOutputFolders(), and SetOutputPath().

◆ m_levelsToCheck

uint32_t ns3::SatEnvVariables::m_levelsToCheck
private

How many directory levels to check for data path.

Definition at line 264 of file satellite-env-variables.h.

Referenced by SatEnvVariables(), LocateDirectory(), and LocateFile().

◆ m_outputPath

std::string ns3::SatEnvVariables::m_outputPath
private

Result output path.

Definition at line 274 of file satellite-env-variables.h.

Referenced by SatEnvVariables(), DumpSimulationInformation(), GetOutputPath(), InitializeOutputFolders(), and SetOutputPath().

◆ m_pathToExecutable

std::string ns3::SatEnvVariables::m_pathToExecutable
private

Path to executable.

Definition at line 249 of file satellite-env-variables.h.

Referenced by SatEnvVariables(), DoDispose(), DoInitialize(), GetPathToExecutable(), and SetPathToExecutable().

◆ m_pathToExecutableFromAttribute

std::string ns3::SatEnvVariables::m_pathToExecutableFromAttribute
private

Path to executable (attribute value).

Definition at line 259 of file satellite-env-variables.h.

Referenced by SatEnvVariables(), GetPathToExecutable(), and GetTypeId().

◆ m_simRootPath

std::string ns3::SatEnvVariables::m_simRootPath
private

Path to the simulation output root folder.

Definition at line 284 of file satellite-env-variables.h.

Referenced by SatEnvVariables(), and InitializeOutputFolders().

◆ m_simTag

std::string ns3::SatEnvVariables::m_simTag
private

Tag related to the current simulation.

Definition at line 289 of file satellite-env-variables.h.

Referenced by SatEnvVariables(), DoInitialize(), GetOutputPath(), GetTypeId(), and SetOutputVariables().

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