Manual for OpenFLUID 2.1.10

Public Member Functions | List of all members
openfluid::buddies::ExamplesBuddy Class Reference

#include <buddies/ExamplesBuddy.hpp>

Public Member Functions

 ExamplesBuddy (openfluid::buddies::BuddiesListener *Listener)
 
 ~ExamplesBuddy ()
 
bool run ()
 
bool installExampleFolder (const std::string &SourcePath, const std::string &InstallPath, const std::string &FolderName, const bool Force=false)
 
bool installExampleProject (const std::string &ProjectsSourcePath, const std::string &ProjectsInstallPath, const std::string &ProjectDir, const bool Force=false)
 
bool installExampleSimulator (const std::string &SimulatorSourcePath, const std::string &SimulatorInstallPath, const std::string &SimulatorDir, const bool Force=false)
 
bool installAllExamplesFolders (const std::string &ExamplesSourcePath, const std::string &ExamplesInstallPath, const bool Force=false)
 
- Public Member Functions inherited from openfluid::buddies::OpenFLUIDBuddy
 OpenFLUIDBuddy (openfluid::buddies::BuddiesListener *Listener)
 
virtual ~OpenFLUIDBuddy ()
 
bool parseOptions (std::string OptsStr)
 
void streamOptions (std::ostream &OStream)
 
void invokeHelp ()
 

Additional Inherited Members

- Protected Member Functions inherited from openfluid::buddies::OpenFLUIDBuddy
void setOptionIfNotSet (std::string OptionName, std::string OptionValue)
 
std::string getYesNoFromOneZero (std::string VStr)
 
- Protected Attributes inherited from openfluid::buddies::OpenFLUIDBuddy
std::map< std::string, std::string > m_Options
 
std::map< std::string, std::string > m_RequiredOptionsHelp
 
std::map< std::string, std::string > m_OtherOptionsHelp
 
openfluid::buddies::BuddiesListenermp_Listener
 
Inheritance diagram for openfluid::buddies::ExamplesBuddy:
Inheritance graph
[legend]
Collaboration diagram for openfluid::buddies::ExamplesBuddy:
Collaboration graph
[legend]

Constructor & Destructor Documentation

◆ ExamplesBuddy()

openfluid::buddies::ExamplesBuddy::ExamplesBuddy ( openfluid::buddies::BuddiesListener Listener)

◆ ~ExamplesBuddy()

openfluid::buddies::ExamplesBuddy::~ExamplesBuddy ( )

Member Function Documentation

◆ installAllExamplesFolders()

bool openfluid::buddies::ExamplesBuddy::installAllExamplesFolders ( const std::string &  ExamplesSourcePath,
const std::string &  ExamplesInstallPath,
const bool  Force = false 
)

◆ installExampleFolder()

bool openfluid::buddies::ExamplesBuddy::installExampleFolder ( const std::string &  SourcePath,
const std::string &  InstallPath,
const std::string &  FolderName,
const bool  Force = false 
)

◆ installExampleProject()

bool openfluid::buddies::ExamplesBuddy::installExampleProject ( const std::string &  ProjectsSourcePath,
const std::string &  ProjectsInstallPath,
const std::string &  ProjectDir,
const bool  Force = false 
)

◆ installExampleSimulator()

bool openfluid::buddies::ExamplesBuddy::installExampleSimulator ( const std::string &  SimulatorSourcePath,
const std::string &  SimulatorInstallPath,
const std::string &  SimulatorDir,
const bool  Force = false 
)

◆ run()

bool openfluid::buddies::ExamplesBuddy::run ( )
virtual

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