.. py:module:: mhi.xml.pscad.workspace
	:synopsis: PSCAD Workspaces (projects & simulation sets)

.. py:currentmodule:: mhi.xml.pscad.workspace

=========
Workspace
=========

The PSCAD Workspace file is an XML document which contains:

- the workspace parameters,
- the workspace project files:

  - libraries,
  - cases,
- the workspace simulations sets.


--------------
Workspace File
--------------

.. py:currentclass: WorkspaceFile

.. autoclass:: WorkspaceFile

	.. autoproperty:: name
	.. autoproperty:: path
	.. autoproperty:: folder
	.. autoproperty:: version

	.. automethod:: save
	.. automethod:: save_as

	.. automethod:: all_exist
	.. automethod:: add_project

	.. autoproperty:: project
	.. autoproperty:: simulation_set


---------------
Projects
---------------

.. autoclass:: ProjectMapping
	:members:


------------
Project
------------

.. autoclass:: ProjectNode
	:members:
	:exclude-members: Type


---------------
Simulation Sets
---------------

.. autoclass:: SimulationSetMapping
	:members:


--------------
Simulation Set
--------------

.. autoclass:: SimulationSetNode

	.. autoproperty:: task
	.. autoproperty:: depends_on

	.. automethod:: namespaces
	.. automethod:: delete
	.. automethod:: parameters

	.. autoclass:: mhi.xml.pscad.workspace::SimulationSetNode.Parameters()
		:members:
		:undoc-members:


--------------------
Simulation Set Tasks
--------------------

.. autoclass:: TaskMapping

	.. automethod:: namespaces


-------------------
Simulation Set Task
-------------------

.. autoclass:: SimulationTaskNode

	.. autoproperty:: namespace
	.. automethod:: delete
	.. automethod:: parameters

	.. autoclass:: mhi.xml.pscad.workspace::SimulationTaskNode.Parameters()
		:members:
		:undoc-members:
