capture_context#

Session.capture_context(full_context: bool = False) enscontext.EnsContext#

Capture the current EnSight instance state.

This method causes the EnSight instance to save a context and return an EnsContext object representing that saved state.

Parameters:
full_contextbool, optional

Whether to include all aspects of the Ensight instance. The default is False.

Returns:
enscontext.EnsContext

Examples

>>> ctx = session.capture_context()
>>> ctx.save("session_context.ctxz")