ViewerSetup

Qualified name: api.postprocessor.viewers.viewer_setup.ViewerSetup

class api.postprocessor.viewers.viewer_setup.ViewerSetup(viewer)

Bases: ABC

Methods

get_name	Returns the name of the viewer
set_name	Changes the name of the viewer

abstract get_name() → str

Returns the name of the viewer

Example

>>> from more.api import ApiGateway
>>> api = ApiGateway(proj=proj)
>>> postprocessor_setup = api.create_postprocessor_setup()

>>> simresult_setup = postprocessor_setup.get_simresult(name='example_simresult') # The simresult object must already exist
>>> evaluation_setup = simresult_setup.create_evaluation(evaluation_type='Custom')
>>> viewer_setup = evaluation_setup.create_viewer('Figure').set_name(name='New name')

Returns:

name – The name of the viewer

Return type:

str

abstract set_name(name: str, resolve_duplicate_name: bool = False) → ViewerSetup

Changes the name of the viewer

Example

>>> from more.api import ApiGateway
>>> api = ApiGateway(proj=proj)
>>> postprocessor_setup = api.create_postprocessor_setup()

>>> simresult_setup = postprocessor_setup.get_simresult(name='example_simresult') # The simresult object must already exist
>>> evaluation_setup = simresult_setup.create_evaluation(evaluation_type='Custom')
>>> viewer_setup = evaluation_setup.create_viewer(viewer_type='Figure')
>>> viewer_setup.set_name(name='new_name')
<more...>
>>> second_viewer_setup = evaluation_setup.create_viewer(viewer_type='Figure') \
...     .set_name(name='new_name', resolve_duplicate_name=True)
>>> second_viewer_setup.get_name()
'new_name 1'

Parameters:

• name (str) – The new name of the viewer

• resolve_duplicate_name (bool) – Whether to automatically assign a new name when the chosen one is already taken

Returns:

self

Return type:

ViewerSetup

Raises:

• TypeError – Raised if the given name is not a string

• NameNotUniqueError –