gemseo.core.monitoring module

Monitoring mechanism to track GEMSEO execution (update events).

class Monitoring(*args, **kwargs)

Bases: object

This class implements the observer pattern.

It is a singleton, it is called by GEMSEO core classes like MDODicipline whenever an event of interest like a status change occurs. Client objects register with add_observer and are notified whenever a discipline status change occurs.

Parameters:

• scenario -- The scenario to be monitored.

• args (Any)

• kwargs (Any)

Return type:

Any

add_observer(observer)

Register an observer object interested in observable update events.

Parameters:

observer (Observer) -- The object to be notified.

Return type:

None

get_statuses()

Get the statuses of all disciplines.

Returns:

These statuses associated with the atom ids.

Return type:

dict[str, ExecutionStatus.Status]

remove_all_observers()

Unsubscribe all observers.

Return type:

None

remove_observer(observer)

Unsubscribe the given observer.

Parameters:

observer (Observer) -- The observer to be removed.

Return type:

None

update(atom)

Notify the observers that the corresponding observable object is updated.

Observers have to know what to retrieve from the observable object.

Parameters:

atom (Any) -- The updated object.

Return type:

None

workflow: BaseExecutionSequence

The execution sequence.