satellite-env-variables.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2013 Magister Solutions Ltd.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation;
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * Author: Frans Laakso <frans.laakso@magister.fi>
 */
#ifndef SATELLITE_ENV_VARIABLES_H
#define SATELLITE_ENV_VARIABLES_H
 
#include "satellite-output-fstream-string-container.h"
 
#include "ns3/log.h"
#include "ns3/object.h"
#include "ns3/simulator.h"
 
#include <stdint.h>
 
namespace ns3
{

class SatEnvVariables : public Object
{
  public:
    static TypeId GetTypeId(void);

    SatEnvVariables();

    virtual void NotifyConstructionCompleted() override;

    ~SatEnvVariables();
 
    static Ptr<SatEnvVariables> GetInstance();

    std::string GetCurrentWorkingDirectory();

    std::string GetPathToExecutable();

    void SetCurrentWorkingDirectory(std::string currentWorkingDirectory);

    void SetPathToExecutable(std::string pathToExecutable);

    void CreateDirectory(std::string path);

    std::string GetDataPath()
    {
        return m_dataPath;
    }

    std::string GetOutputPath();

    void SetOutputPath(std::string outputPath);

    std::string LocateDataDirectory();

    std::string LocateDirectory(std::string initialPath);

    std::string LocateFile(std::string initialPath);

    bool IsValidDirectory(std::string path);

    bool IsValidFile(std::string pathToFile);

    std::string GetCurrentDateAndTime();

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

    void DoInitialize();

    void DoDispose();
 
  private:
    std::string InitializeOutputFolders(std::string campaignName,
                                        std::string simTag,
                                        bool enableOutputOverwrite);

    void DumpSimulationInformation();

    void DumpRevisionDiff(std::string dataPath);

    void ExecuteCommandAndReadOutput(std::string command,
                                     Ptr<SatOutputFileStreamStringContainer> outputContainer);

    std::string AddToPath(std::string path, std::string stringToAdd);

    std::string FormOutputPath(std::string simRootPath,
                               std::string campaignName,
                               std::string simTag,
                               std::string safetyTag);

    std::string m_currentWorkingDirectory;

    std::string m_pathToExecutable;

    std::string m_currentWorkingDirectoryFromAttribute;

    std::string m_pathToExecutableFromAttribute;

    uint32_t m_levelsToCheck;

    std::string m_dataPath;

    std::string m_outputPath;

    std::string m_campaignName;

    std::string m_simRootPath;

    std::string m_simTag;

    bool m_enableOutputOverwrite;

    bool m_isOutputPathInitialized;

    bool m_enableSimInfoOutput;

    bool m_enableSimInfoDiffOutput;

    bool m_excludeDataFolderFromDiff;

    bool m_isInitialized;

    static Ptr<SatEnvVariables> m_instance;
};
 
} // namespace ns3
 
#endif /* SATELLITE_ENV_VARIABLES_H */