SimPT_Shell::Ws::Workspace Class Reference

Abstraction for workspace info in the file system. More...

#include <Workspace.h>

Inheritance diagram for SimPT_Shell::Ws::Workspace:

Collaboration diagram for SimPT_Shell::Ws::Workspace:

Public Member Functions
	Workspace (const std::string &path, const std::string &prefs_file)
virtual	~Workspace ()
	Virtual destructor.
Public Member Functions inherited from SimShell::Ws::Workspace< Project, WorkspaceFactory::g_workspace_index_file >
	Workspace (const std::string &path, const std::string &prefs_file)
	Constructor. More...
	Workspace (Workspace< Project, index_file > &&)
	Move constructor.
virtual ProjectIterator	Add (const std::string &type, const std::string &name)
virtual std::shared_ptr< IProject >	Back ()
virtual std::shared_ptr< const IProject >	Back () const
virtual ProjectIterator	begin ()
virtual ConstProjectIterator	begin () const
virtual ProjectIterator	end ()
virtual ConstProjectIterator	end () const
virtual ProjectIterator	Find (const std::string &name)
virtual ConstProjectIterator	Find (const std::string &name) const
virtual std::shared_ptr< IProject >	Front ()
virtual std::shared_ptr< const IProject >	Front () const
virtual std::shared_ptr< IProject >	Get (const std::string &name)
virtual std::shared_ptr< const IProject >	Get (const std::string &name) const
virtual const std::string &	GetIndexFile () const
virtual const std::string &	GetPath () const
virtual const boost::property_tree::ptree &	GetUserData (const std::string &user) const
virtual bool	IsProject (const std::string &name) const
virtual ProjectIterator	New (const std::string &type, const std::string &name)
virtual void	Refresh ()
virtual void	Remove (ProjectIterator)
virtual void	Remove (const std::string &name)
virtual ProjectIterator	Rename (ProjectIterator, const std::string &new_name)
virtual ProjectIterator	Rename (const std::string &old_name, const std::string &new_name)
virtual void	SetUserData (const std::string &user, const boost::property_tree::ptree &)
Public Member Functions inherited from SimShell::Ws::IWorkspace
virtual	~IWorkspace ()
	Virtual destructor.
Public Member Functions inherited from SimPT_Sim::Util::Subject< Event::PreferencesChanged, std::weak_ptr< const void > >
void	Notify (const EventType &)
void	Register (const U *, CallbackType)
void	Unregister (const U *)
void	UnregisterAll ()
Public Member Functions inherited from SimPT_Sim::Util::Subject< Event::WorkspaceChanged, std::weak_ptr< const void > >
void	Notify (const EventType &)
void	Register (const U *, CallbackType)
void	Unregister (const U *)
void	UnregisterAll ()
Public Member Functions inherited from SimShell::Ws::Preferences
	Preferences (const std::string &file)
	Preferences (Preferences &&)
virtual const boost::property_tree::ptree &	GetPreferences () const
virtual void	SetPreferences (const boost::property_tree::ptree &)

Static Public Member Functions
static void	Init (const std::string &path)

Additional Inherited Members
Public Types inherited from SimShell::Ws::IWorkspace
using	ConstProjectIterator = typename ProjectMap::const_iterator
using	ProjectIterator = typename ProjectMap::iterator
using	ProjectMap = std::map< std::string, ProjectMapEntry >
Public Types inherited from SimPT_Sim::Util::Subject< Event::PreferencesChanged, std::weak_ptr< const void > >
typedef std::function< void(const EventType &)>	CallbackType
typedef Event::PreferencesChanged	EventType
typedef const std::weak_ptr< const void > *	KeyType
Public Types inherited from SimPT_Sim::Util::Subject< Event::WorkspaceChanged, std::weak_ptr< const void > >
typedef std::function< void(const EventType &)>	CallbackType
typedef Event::WorkspaceChanged	EventType
typedef const std::weak_ptr< const void > *	KeyType
Protected Attributes inherited from SimShell::Ws::Workspace< Project, WorkspaceFactory::g_workspace_index_file >
Util::FileSystemWatcher	m_filesystem_watcher
	Watch workspace index file for changes.
std::string	m_path
	Path workspace was initialized with.
std::string	m_prefs_file
	Name of preferences file.
ProjectMap	m_projects
	Mapping from project name to project.
boost::property_tree::ptree	m_user_data
	GetUserData() with non-existing argument creates an empty user data.
Protected Attributes inherited from SimShell::Ws::Preferences
boost::property_tree::ptree	m_preferences

Detailed Description

Abstraction for workspace info in the file system.

Definition at line 41 of file cpp_simptshell/workspace/Workspace.h.

---

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

• cpp_simptshell/workspace/Workspace.h
• Workspace.cpp