pyIPCMI.ToolChain.Mentor.py

Submodules

• pyIPCMI.ToolChain.Mentor.ModelSim.py
• pyIPCMI.ToolChain.Mentor.QuestaSim.py

Exceptions

• MentorException: Base class for all tool specific exceptions

Classes

• Configuration: Configuration routines for Mentor Graphics as a vendor.

exception pyIPCMI.ToolChain.Mentor.MentorException(message='')

Inheritance

Members

__init__(message='')

Exception initializer

Parameters:message (str) – The exception message.

__str__()

Returns the exception’s message text.

args

class pyIPCMI.ToolChain.Mentor.Configuration(host: pyIPCMI.Base.IHost)

Configuration routines for Mentor Graphics as a vendor.

This configuration provides a common installation directory setup for all Mentor Graphics tools installed on a system.

Inheritance

Members

_vendor = 'Mentor'

The name of the tools vendor.

_section = 'INSTALL.Mentor'

The name of the configuration section. Pattern: INSTALL.Vendor.ToolName.

_template = {'ALL': {'INSTALL.ModelSim': {'SectionName': '', 'AdditionalVComOptions': '${${SectionName}:AdditionalVComOptions}', 'Edition': '${${SectionName}:Edition}', 'AdditionalVSimOptions': '${${SectionName}:AdditionalVSimOptions}', 'Version': '${${SectionName}:Version}', 'InstallationDirectory': '${${SectionName}:InstallationDirectory}', 'BinaryDirectory': '${${SectionName}:BinaryDirectory}'}}, 'Linux': {'INSTALL.Mentor': {'InstallationDirectory': '/opt/mentor'}}, 'Windows': {'INSTALL.Mentor': {'InstallationDirectory': 'C:/Mentor'}}}

The template for the configuration sections represented as nested dictionaries.

_GetDefaultInstallationDirectory()

Return unresolved default installation directory (str) from template.

Overwrite function in sub-class for automatic search of installation directory.

CheckDependency()

Check if all vendor or tool dependencies are fulfilled to configure this tool.

ClearSection(writeWarnings=False)

Clear the configuration section associated to this Configuration class.

ConfigureForAll()

Start a generic (platform independent) vendor configuration procedure.

This method configures a vendor path. Overwrite this method to implement a vendor specific configuration routine for a vendor Configuration class.

ConfigureForDarwin()

Start the configuration procedure for Darwin.

This method is a wrapper for ConfigureForAll(). Overwrite this method to implement a Darwin specific configuration routine.

ConfigureForLinux()

Start the configuration procedure for Linux.

This method is a wrapper for ConfigureForAll(). Overwrite this method to implement a Linux specific configuration routine.

ConfigureForWindows()

Start the configuration procedure for Windows.

This method is a wrapper for ConfigureForAll(). Overwrite this method to implement a Windows specific configuration routine.

classmethod GetSections(platform)

Return all section names for this configuration.

Host

Return the hosting object.

IsConfigured()

Return true if the configurations section is configured

IsSupportedPlatform()

Return true if the given platform is supported by this configuration routine.

Log(entry, condition=True)

Write an entry to the local logger.

LogDebug(*args, condition=True, **kwargs)

LogDryRun(*args, condition=True, **kwargs)

LogError(*args, condition=True, **kwargs)

LogFatal(*args, condition=True, **kwargs)

LogInfo(*args, condition=True, **kwargs)

LogNormal(*args, condition=True, **kwargs)

LogQuiet(*args, condition=True, **kwargs)

LogVerbose(*args, condition=True, **kwargs)

LogWarning(*args, condition=True, **kwargs)

Logger

Return the local logger instance.

PrepareOptions(writeWarnings=True)

PrepareSections(warningWasWritten, writeWarnings=True)

RunPostConfigurationTasks()

Virtual method. Overwrite to execute post-configuration tasks.

SectionName

Return the configuration’s section name.

State

Return the configuration state.

_Ask(question, default, beforeDefault='', afterDefault='', indent=1)

_AskInstalled(question)

Ask a Yes/No/Pass question.

_AskYes_NoPass(question, indent=1)

Ask a yes/NO/pass question.

_Ask_YesNoPass(question, indent=1)

Ask a YES/no/pass question.

_ConfigureInstallationDirectory()

Asks for installation directory and updates section. Checks if entered directory exists and returns Path object. If no installation directory was configured before, then _GetDefaultInstallationDir is called.

_GetDefaultOptionValue(optionName)

_PrintAvailableEditions(editions, selectedEdition)

Print all available editions and return the selected index.

_TestDefaultInstallPath(defaults)

Helper function for automatic search of installation directory.

_TryLog(*args, condition=True, **kwargs)

_multiVersionSupport = False