VPTissue Reference Manual
SimShell::Ws::IWorkspaceFactory Class Referenceabstract

Interface for factories creating an application-specific workspace. More...

#include <IWorkspaceFactory.h>

Inheritance diagram for SimShell::Ws::IWorkspaceFactory:
Inheritance graph
Collaboration diagram for SimShell::Ws::IWorkspaceFactory:
Collaboration graph

Public Member Functions

virtual ~IWorkspaceFactory ()
 Virtual destructor.
virtual std::shared_ptr< IWorkspaceCreateWorkspace (const std::string &path)=0
 Open workspace with given path and return interface to it.
virtual std::string GetDefaultWorkspaceName () const =0
 Get default workspace name. More...
virtual std::string GetWorkspaceTemplatePath () const =0
 Get path to template workspace. More...
virtual void InitWorkspace (const std::string &path)=0
 Initialize empty workspace at given path.

Detailed Description

Interface for factories creating an application-specific workspace.

Definition at line 29 of file IWorkspaceFactory.h.

Member Function Documentation

virtual std::string SimShell::Ws::IWorkspaceFactory::GetDefaultWorkspaceName ( ) const
pure virtual

Get default workspace name.

This string will determine the default path shown in the "Switch Workspace..."-wizard: <user's home dir/<default workspace="" name>="">.

Implemented in SimPT_Shell::Ws::WorkspaceFactory.

virtual std::string SimShell::Ws::IWorkspaceFactory::GetWorkspaceTemplatePath ( ) const
pure virtual

Get path to template workspace.

The template workspace is a workspace containing example projects.

Implemented in SimPT_Shell::Ws::WorkspaceFactory.

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