pyaedt.application.MessageManager.AEDTMessageManager

class pyaedt.application.MessageManager.AEDTMessageManager(app=None)[source]

Manages AEDT messaging to both the logger and the AEDT Message Manager window.

Parameters
parent

The default is None.

Examples

Log the three types of messages.

>>> from pyaedt.hfss import Hfss
>>> hfss = Hfss()
>>> hfss.logger.design.info("This is an info message on a design", "Design")
>>> hfss.logger.warning("This is a global warning message", "Global")
>>> hfss.logger.project.error("This is a project error message", "Project")
Attributes
messageslist

Message manager content for the active project and design.

Methods

add_warning_message(message_text[, level])

Add a type 1 “Warning” message to the Message Manager tree.

add_info_message(message_text[, level])

Add a type 0 “Info” message to the active design level of the Message Manager tree.

clear_messages([proj_name, des_name, level])

Clear all messages.

add_error message

add debug_message (deprecated)

add message

get_design_messages

Methods

AEDTMessageManager.add_debug_message(type, …)

Parameterized message to the Message Manager to specify the type and project or design level.

AEDTMessageManager.add_error_message(…[, …])

Add a type 2 “Error” message to the Message Manager tree.

AEDTMessageManager.add_info_message(message_text)

Add a type 0 “Info” message to the active design level of the Message Manager tree.

AEDTMessageManager.add_message(type, …[, …])

Pass a parameterized message to the Message Manager to specify the type and project or design level.

AEDTMessageManager.add_warning_message(…)

Add a type 1 “Warning” message to the Message Manager tree.

AEDTMessageManager.clear_messages([…])

Clear all messages.

AEDTMessageManager.get_messages(…)

Retrieve the Message Manager content for a specified project and design.

Attributes

AEDTMessageManager.messages

Message manager content for the active project and design.