AnalysisSequence Class Reference

Defines a Sequence of CAPS Analysis Objects. More...

Inheritance diagram for AnalysisSequence:

Collaboration diagram for AnalysisSequence:

Public Member Functions
	create (self, aim, name=None, capsIntent=None, unitSystem=None, autoExec=True)
	Create a CAPS Analysis Object.
	copy (self, src, name=None)
	Create a copy of an CAPS Analysis Object.
	dirty (self)
	Returns analyses that are dirty.
Public Member Functions inherited from Sequence
	keys (self)
	Returns the keys of the Sequence.
	values (self)
	Returns the values of the Sequence.
	items (self)
	Returns the items of the Sequence.

Detailed Description

Defines a Sequence of CAPS Analysis Objects.

Member Function Documentation

copy()

copy	(		self,
			src,
			name = None
	)

Create a copy of an CAPS Analysis Object.

Parameters

src	Name of the source Analysis Object or an Analysis Object
name	Name of the new Analysis Object copy

create()

create	(		self,
			aim,
			name = None,
			capsIntent = None,
			unitSystem = None,
			autoExec = True
	)

Create a CAPS Analysis Object.

Parameters

aim	Name of the AIM module
name	Name (e.g. key) of the Analysis Object. Must be unique if specified. If None, the defalt is aim+str(instanceCount) where instanceCount is the count of the existing 'aim' instances.
capsIntent	Analysis intention in which to invoke the AIM.
unitSystem	See AIM documentation for usage.
autoExec	If false dissable any automatic execution of the AIM.

Returns

The new Analysis Object is added to the sequence and returned

dirty()

dirty

(

self

)

Returns analyses that are dirty.

Returns

A list of dirty analyses. An empty list is returned if no analyses are dirty.

---

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

• pyCAPS/problem.py