recording_manager.py

RecordingManager class definition.

class openmdao.recorders.recording_manager.RecordingManager[source]

Bases: object

Object that routes function calls to all attached recorders.

Attributes

rank (int) Rank of the iteration coordinate.
__getitem__(index)[source]

Get a particular recorder in the manager.

Parameters:

index : int

an index into _recorders.

Returns:

recorder : BaseRecorder

a recorder from _recorders

__init__()[source]

init.

__iter__()[source]

Iterate.

Returns:

iter : BaseRecorder

a recorder from _recorders.

append(recorder)[source]

Add a recorder for recording.

Parameters:

recorder : BaseRecorder

Recorder instance to be added to the manager.

close()[source]

Close all recorders in the manager.

has_recorders()[source]

Are there any recorders managed by this RecordingManager.

Returns:

True/False : bool

True if RecordingManager is managing at least one recorder

record_iteration(recording_requester, data, metadata)[source]

Call record_iteration on all recorders.

Parameters:

recording_requester : object

The object that needs an iteration of itself recorded.

data : dict

Dictionary containing desvars, objectives, constraints, responses, and System vars.

metadata : dict

Metadata for iteration coordinate.

record_metadata(recording_requester)[source]

Call record_metadata for all recorders.

Parameters:

recording_requester : object

The object that needs its metadata recorded.

startup(recording_requester)[source]

Run startup on each recorder in the manager.

Parameters:

recording_requester : object

The object that needs an iteration of itself recorded.