Documentation for OpenFLUID 2.2.0
openfluid::base::WorkspaceManager Class Reference

#include <base/WorkspaceManager.hpp>

Classes

struct  RecentProject
 

Public Member Functions

void openWorkspace (const std::string &Path)
 
void closeWorkspace ()
 
bool isOpen () const
 
std::string getWorkspacePath () const
 
std::string getSettingsFile () const
 
std::string getProjectsPath () const
 
std::string getProjectPath (const std::string &Name) const
 
void insertRecentProject (const std::string &Name, const std::string &Path)
 
std::list< RecentProjectgetRecentProjects () const
 
void clearRecentProjects ()
 
std::string getWaresPath (openfluid::ware::WareType Type=openfluid::ware::WareType::UNDEFINED) const
 
std::string getWarePath (openfluid::ware::WareType Type, const openfluid::ware::WareID_t &ID) const
 
std::vector< std::string > getOpenWaresPaths () const
 
void setOpenWaresPaths (const std::vector< std::string > &Paths)
 
std::string getActiveWarePath () const
 
void setActiveWarePath (const std::string &Path)
 
std::string getWaresConfigureMode () const
 
void setWaresConfigureMode (const std::string &Mode)
 
std::string getWaresBuildMode () const
 
void setWaresBuildMode (const std::string &Mode)
 
bool isWaresParallelJobsEnabled () const
 
void setWaresParallelJobsEnabled (bool Enabled)
 
int getWaresParallelJobsCount () const
 
void setWaresParallelJobsCount (int Jobs)
 

Static Public Member Functions

static void prepareWorkspace (const std::string &Path)
 
static std::string getSettingsFile (const std::string &WorkspacePath)
 
static std::string getProjectsPath (const std::string &WorkspacePath)
 
static std::string getWaresPath (const std::string &WorkspacePath, openfluid::ware::WareType Type=openfluid::ware::WareType::UNDEFINED)
 
static std::string getWarePath (const std::string &WorkspacePath, openfluid::ware::WareType Type, const openfluid::ware::WareID_t &ID)
 

Static Public Attributes

static const unsigned int RecentProjectsMax
 

Member Function Documentation

◆ clearRecentProjects()

void openfluid::base::WorkspaceManager::clearRecentProjects ( )

◆ closeWorkspace()

void openfluid::base::WorkspaceManager::closeWorkspace ( )

◆ getActiveWarePath()

std::string openfluid::base::WorkspaceManager::getActiveWarePath ( ) const

◆ getOpenWaresPaths()

std::vector<std::string> openfluid::base::WorkspaceManager::getOpenWaresPaths ( ) const

◆ getProjectPath()

std::string openfluid::base::WorkspaceManager::getProjectPath ( const std::string &  Name) const

◆ getProjectsPath() [1/2]

std::string openfluid::base::WorkspaceManager::getProjectsPath ( ) const

◆ getProjectsPath() [2/2]

static std::string openfluid::base::WorkspaceManager::getProjectsPath ( const std::string &  WorkspacePath)
static

◆ getRecentProjects()

std::list<RecentProject> openfluid::base::WorkspaceManager::getRecentProjects ( ) const

◆ getSettingsFile() [1/2]

std::string openfluid::base::WorkspaceManager::getSettingsFile ( ) const

◆ getSettingsFile() [2/2]

static std::string openfluid::base::WorkspaceManager::getSettingsFile ( const std::string &  WorkspacePath)
static

◆ getWarePath() [1/2]

static std::string openfluid::base::WorkspaceManager::getWarePath ( const std::string &  WorkspacePath,
openfluid::ware::WareType  Type,
const openfluid::ware::WareID_t ID 
)
static

◆ getWarePath() [2/2]

std::string openfluid::base::WorkspaceManager::getWarePath ( openfluid::ware::WareType  Type,
const openfluid::ware::WareID_t ID 
) const

◆ getWaresBuildMode()

std::string openfluid::base::WorkspaceManager::getWaresBuildMode ( ) const

◆ getWaresConfigureMode()

std::string openfluid::base::WorkspaceManager::getWaresConfigureMode ( ) const

◆ getWaresParallelJobsCount()

int openfluid::base::WorkspaceManager::getWaresParallelJobsCount ( ) const

◆ getWaresPath() [1/2]

static std::string openfluid::base::WorkspaceManager::getWaresPath ( const std::string &  WorkspacePath,
openfluid::ware::WareType  Type = openfluid::ware::WareType::UNDEFINED 
)
static

◆ getWaresPath() [2/2]

std::string openfluid::base::WorkspaceManager::getWaresPath ( openfluid::ware::WareType  Type = openfluid::ware::WareType::UNDEFINED) const

◆ getWorkspacePath()

std::string openfluid::base::WorkspaceManager::getWorkspacePath ( ) const
inline

◆ insertRecentProject()

void openfluid::base::WorkspaceManager::insertRecentProject ( const std::string &  Name,
const std::string &  Path 
)

◆ isOpen()

bool openfluid::base::WorkspaceManager::isOpen ( ) const
inline

◆ isWaresParallelJobsEnabled()

bool openfluid::base::WorkspaceManager::isWaresParallelJobsEnabled ( ) const

◆ openWorkspace()

void openfluid::base::WorkspaceManager::openWorkspace ( const std::string &  Path)

◆ prepareWorkspace()

static void openfluid::base::WorkspaceManager::prepareWorkspace ( const std::string &  Path)
static

◆ setActiveWarePath()

void openfluid::base::WorkspaceManager::setActiveWarePath ( const std::string &  Path)

◆ setOpenWaresPaths()

void openfluid::base::WorkspaceManager::setOpenWaresPaths ( const std::vector< std::string > &  Paths)

◆ setWaresBuildMode()

void openfluid::base::WorkspaceManager::setWaresBuildMode ( const std::string &  Mode)

◆ setWaresConfigureMode()

void openfluid::base::WorkspaceManager::setWaresConfigureMode ( const std::string &  Mode)

◆ setWaresParallelJobsCount()

void openfluid::base::WorkspaceManager::setWaresParallelJobsCount ( int  Jobs)

◆ setWaresParallelJobsEnabled()

void openfluid::base::WorkspaceManager::setWaresParallelJobsEnabled ( bool  Enabled)

Member Data Documentation

◆ RecentProjectsMax

const unsigned int openfluid::base::WorkspaceManager::RecentProjectsMax
inlinestatic

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