Workspace manager for cli applications. More...

Collaboration diagram for SimPT_Shell::CliWorkspaceManager:

Static Public Member Functions
static SimShell::Ws::IProject::FileIterator	OpenLeaf (std::shared_ptr< SimShell::Ws::IProject > project, const std::string &input_file, bool create_if_not_exists, std::shared_ptr< SimShell::Ws::IFile > ref_input_file)
	Return the input file that already existed or has been newly created. More...

static SimShell::Ws::IProject::FileIterator	OpenLeaf (std::shared_ptr< SimShell::Ws::IProject > project, const std::string &file_name, bool create_if_not_exist=true, const std::string &ref_ws_path="", const std::string &ref_project="", const std::string &ref_file_name="")
	Return the sim data file that already existed or has been newly created. More...

static SimShell::Ws::IWorkspace::ProjectIterator	OpenProject (std::shared_ptr< CliWorkspace > workspace, const std::string &project, bool create_if_not_exist=true)
	Return the project that already existed or has been newly created. More...

static std::shared_ptr< CliWorkspace >	OpenWorkspace (const std::string &base_path, const std::string &workspace, bool create_if_not_exist=true)
	Return workspace that already existed or has been newly created (in empty state). More...

Detailed Description

Workspace manager for cli applications.

Definition at line 36 of file CliWorkspaceManager.h.

Member Function Documentation

static SimShell::Ws::IProject::FileIterator SimPT_Shell::CliWorkspaceManager::OpenLeaf	(	std::shared_ptr< SimShell::Ws::IProject >	project,
		const std::string &	input_file,
		bool	create_if_not_exists,
		std::shared_ptr< SimShell::Ws::IFile >	ref_input_file
	)

static

Return the input file that already existed or has been newly created.

Parameters

project	project that owns the input file
input_file	input file name
create_if_not_exist	create input file from reference if it did not exist yet
ref_input_file	reference input file in case of creation

static SimShell::Ws::IProject::FileIterator SimPT_Shell::CliWorkspaceManager::OpenLeaf	(	std::shared_ptr< SimShell::Ws::IProject >	project,
		const std::string &	file_name,
		bool	create_if_not_exist = `true`,
		const std::string &	ref_ws_path = `""`,
		const std::string &	ref_project = `""`,
		const std::string &	ref_file_name = `""`
	)

static

Return the sim data file that already existed or has been newly created.

Parameters

project	project that owns the data file
file_name	sim data file name
create_if_not_exist	create file from reference if it did not exist yet
ref_ws_path	path to reference workspace in case of creation
ref_project	name of reference project in case of creation
ref_file_name	name of reference data file in case of creation

SimShell::Ws::IWorkspace::ProjectIterator SimPT_Shell::CliWorkspaceManager::OpenProject	(	std::shared_ptr< CliWorkspace >	workspace,
		const std::string &	project,
		bool	create_if_not_exist = `true`
	)

static

Return the project that already existed or has been newly created.

Parameters

workspace	workspace that owns project
project	name of the project
create_if_not_exists	create empty project if it does not exist yet

Definition at line 117 of file CliWorkspaceManager.cpp.

shared_ptr< CliWorkspace > SimPT_Shell::CliWorkspaceManager::OpenWorkspace	(	const std::string &	base_path,
		const std::string &	workspace,
		bool	create_if_not_exist = `true`
	)

static

Return workspace that already existed or has been newly created (in empty state).

Parameters

base_path	base path to workspace
workspace	name of workspace directory (relative to base path)
create_if_not_exist	creates empty workspace if it does not exist yet

Definition at line 133 of file CliWorkspaceManager.cpp.

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