Public Member Functions | Private Member Functions | Private Attributes | List of all members
ISM::DocumentationHelper Class Reference

#include <DocumentationHelper.hpp>

Public Member Functions

 DocumentationHelper (path outputPath, path dbPath, std::map< std::string, ISM::TracksPtr > &tracksPerPattern)
 
void setReferenceTopology (TopologyPtr topology, const std::string &patternName)
 
void storeIsm (const std::string &filename, const IsmPtr &ism)
 
void storeIsm (const IsmPtr &ism)
 
void storeOptimizationRun (std::vector< std::vector< std::pair< TopologyPtr, unsigned int >>> &history, CostFunctionPtr< TopologyPtr > globalCostFunction, double elapsedRuntime, const std::string &patternName)
 
void storeTopology (TopologyPtr toStore, const std::string &patternName, const std::string &topologyName, std::map< std::string, std::vector< ISM::VoteSpecifierPtr >> objectDefinitons)
 
void writeResult ()
 

Private Member Functions

void storeMetadataToCSV (unsigned int numEvaluatedTopologies, unsigned int numOptimizationRounds, double elapsedRuntime, const std::string &patternName)
 
void storeTopologiesToCSV (std::vector< TopologyPtr > selectedTopologies, const std::string &patternNames)
 
void writeIsmToDB (path dbPath, const IsmPtr &ism)
 
void writeToFile (path filePath, const std::string &content)
 

Private Attributes

const std::string CSV_SUBFOLDER_NAME = "CSV"
 
DotHelperPtr mDotHelper
 
path mOutputPath
 
TopologyPtr mReferenceTopology
 
unsigned int mSelectedTopologyCounter = 1
 
path mSourceDBPath
 
bool mStoreISM = true
 
SVGHelperPtr mSVGHelper
 
const std::string SELECTED_TOPOLOGIES_FOLDER = "allSelectedTopologies"
 
const std::string SVG_SUBFOLDER_NAME = "SVG"
 
const std::string TOPOLOGIES_SUBFOLDER_NAME = "Topologies"
 

Detailed Description

Definition at line 35 of file DocumentationHelper.hpp.

Constructor & Destructor Documentation

ISM::DocumentationHelper::DocumentationHelper ( path  outputPath,
path  dbPath,
std::map< std::string, ISM::TracksPtr > &  tracksPerPattern 
)
inline

Definition at line 38 of file DocumentationHelper.hpp.

Member Function Documentation

void ISM::DocumentationHelper::setReferenceTopology ( TopologyPtr  topology,
const std::string &  patternName 
)

Definition at line 214 of file DocumentationHelper.cpp.

void ISM::DocumentationHelper::storeIsm ( const std::string &  filename,
const IsmPtr &  ism 
)

Definition at line 206 of file DocumentationHelper.cpp.

void ISM::DocumentationHelper::storeIsm ( const IsmPtr &  ism)

Definition at line 201 of file DocumentationHelper.cpp.

void ISM::DocumentationHelper::storeMetadataToCSV ( unsigned int  numEvaluatedTopologies,
unsigned int  numOptimizationRounds,
double  elapsedRuntime,
const std::string &  patternName 
)
private

Definition at line 72 of file DocumentationHelper.cpp.

void ISM::DocumentationHelper::storeOptimizationRun ( std::vector< std::vector< std::pair< TopologyPtr, unsigned int >>> &  history,
CostFunctionPtr< TopologyPtr >  globalCostFunction,
double  elapsedRuntime,
const std::string &  patternName 
)

Definition at line 29 of file DocumentationHelper.cpp.

void ISM::DocumentationHelper::storeTopologiesToCSV ( std::vector< TopologyPtr >  selectedTopologies,
const std::string &  patternNames 
)
private

Definition at line 59 of file DocumentationHelper.cpp.

void ISM::DocumentationHelper::storeTopology ( TopologyPtr  toStore,
const std::string &  patternName,
const std::string &  topologyName,
std::map< std::string, std::vector< ISM::VoteSpecifierPtr >>  objectDefinitons 
)

Definition at line 82 of file DocumentationHelper.cpp.

void ISM::DocumentationHelper::writeIsmToDB ( path  dbPath,
const IsmPtr &  ism 
)
private

Definition at line 142 of file DocumentationHelper.cpp.

void ISM::DocumentationHelper::writeResult ( )

Definition at line 24 of file DocumentationHelper.cpp.

void ISM::DocumentationHelper::writeToFile ( path  filePath,
const std::string &  content 
)
private

Definition at line 124 of file DocumentationHelper.cpp.

Member Data Documentation

const std::string ISM::DocumentationHelper::CSV_SUBFOLDER_NAME = "CSV"
private

Definition at line 66 of file DocumentationHelper.hpp.

DotHelperPtr ISM::DocumentationHelper::mDotHelper
private

Definition at line 74 of file DocumentationHelper.hpp.

path ISM::DocumentationHelper::mOutputPath
private

Definition at line 70 of file DocumentationHelper.hpp.

TopologyPtr ISM::DocumentationHelper::mReferenceTopology
private

Definition at line 80 of file DocumentationHelper.hpp.

unsigned int ISM::DocumentationHelper::mSelectedTopologyCounter = 1
private

Definition at line 78 of file DocumentationHelper.hpp.

path ISM::DocumentationHelper::mSourceDBPath
private

Definition at line 71 of file DocumentationHelper.hpp.

bool ISM::DocumentationHelper::mStoreISM = true
private

Definition at line 76 of file DocumentationHelper.hpp.

SVGHelperPtr ISM::DocumentationHelper::mSVGHelper
private

Definition at line 73 of file DocumentationHelper.hpp.

const std::string ISM::DocumentationHelper::SELECTED_TOPOLOGIES_FOLDER = "allSelectedTopologies"
private

Definition at line 68 of file DocumentationHelper.hpp.

const std::string ISM::DocumentationHelper::SVG_SUBFOLDER_NAME = "SVG"
private

Definition at line 65 of file DocumentationHelper.hpp.

const std::string ISM::DocumentationHelper::TOPOLOGIES_SUBFOLDER_NAME = "Topologies"
private

Definition at line 67 of file DocumentationHelper.hpp.

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

asr_lib_ism
Author(s): Hanselmann Fabian, Heller Florian, Heizmann Heinrich, Kübler Marcel, Mehlhaus Jonas, Meißner Pascal, Qattan Mohamad, Reckling Reno, Stroh Daniel
autogenerated on Wed Jan 8 2020 04:02:41