ToolChains.Mentor.ModelSim¶

Exceptions

ModelSimException: Base class for all tool specific exceptions

Classes

MentorModelSimPEEditions: Enumeration of all ModelSim editions provided by Mentor Graphics itself.
ModelSimEditions: Enumeration of all ModelSim editions provided by Mentor Graphics inclusive
Configuration: Base class for all tool Configuration classes.
ModelSimPEConfiguration: Base class for all tool Configuration classes.
ModelSimSE32Configuration: Base class for all tool Configuration classes.
ModelSimSE64Configuration: Base class for all tool Configuration classes.
Selector: Base class for all Selector classes.

exception ToolChains.Mentor.ModelSim.ModelSimException(message='')[source]¶

Inheritance

Members

__init__(message='')¶

Exception initializer

Parameters:	message (str) – The exception message.

__str__()¶: Returns the exception’s message text.

args¶

class ToolChains.Mentor.ModelSim.MentorModelSimPEEditions(name, section)[source]¶

Enumeration of all ModelSim editions provided by Mentor Graphics itself.

Inheritance

Members

ModelSimPE = 1¶

ModelSimPEEducation = 2¶

class ToolChains.Mentor.ModelSim.ModelSimEditions(name, section)[source]¶

Enumeration of all ModelSim editions provided by Mentor Graphics inclusive editions shipped by other vendors.

Inheritance

Members

ModelSimPE = 1¶

ModelSimSE32 = 2¶

ModelSimSE64 = 3¶

ModelSimAlteraEdition = 4¶

ModelSimIntelEdition = 5¶

QuestaSim = 6¶

class ToolChains.Mentor.ModelSim.Configuration(host: Base.IHost)[source]¶

Inheritance

Members

_vendor = 'Mentor'¶: The name of the tools vendor.

_toolName = 'Mentor ModelSim'¶: The name of the tool.

_multiVersionSupport = True¶: Mentor ModelSim supports multiple versions installed on the same system.

CheckDependency()[source]¶: Check if general Mentor Graphics support is configured in PoC.

ConfigureForAll()[source]¶

Configuration routine for Mentor Graphics ModelSim on all supported platforms.

Ask if ModelSim is installed.

Pass → skip this configuration. Don’t change existing settings.

Yes → collect installation information for ModelSim.

No → clear the ModelSim configuration section.

Ask for ModelSim’s version.
Ask for ModelSim’s edition (PE, PE student, SE 32-bit, SE 64-bit).
Ask for ModelSim’s installation directory.

_GetModelSimVersion(binPath)[source]¶

_CheckModelSimVersion(binPath, version)[source]¶

RunPostConfigurationTasks()[source]¶

ClearSection(writeWarnings=False)[source]¶: Clear the configuration section associated to this Configuration class.

ConfigureForDarwin()[source]¶

Start the configuration procedure for Darwin.

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

ConfigureForLinux()[source]¶

Start the configuration procedure for Linux.

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

ConfigureForWindows()[source]¶

Start the configuration procedure for Windows.

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

GetSections(platform)[source]¶: Return all section names for this configuration.

Host¶: Return the hosting object.

IsConfigured()[source]¶: Return true if the configurations section is configured

IsSupportedPlatform()[source]¶: 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)[source]¶

PrepareSections(warningWasWritten, writeWarnings=True)[source]¶

PrepareVersionedSections(writeWarnings=False)¶

SectionName¶: Return the configuration’s section name.

State¶: Return the configuration state.

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

_AskInstalled(question)[source]¶: 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.

_ConfigureBinaryDirectory()¶: Updates section with value from _template and returns directory as Path object.

_ConfigureEdition(editions, defaultEdition)¶

_ConfigureInstallationDirectory()[source]¶: 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.

_ConfigureVersion()¶: If no version was configured before, then _GetDefaultVersion is called. Asks for version and updates section. Returns version as string.

_GetDefaultEdition()¶

Returns unresolved default edition (str) from template.

Overwrite this method in a sub-class for automatic search of editions.

_GetDefaultInstallationDirectory()[source]¶

Return unresolved default installation directory (str) from template.

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

_GetDefaultOptionValue(optionName)[source]¶

_GetDefaultVersion()¶

Returns unresolved default version (str) from template.

Overwrite this method in a sub-class for automatic search of version.

_PrintAvailableEditions(editions, selectedEdition)¶: Print all available editions and return the selected index.

_TestDefaultInstallPath(defaults)[source]¶: Helper function for automatic search of installation directory.

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

_section = 'INSTALL.Vendor.Tool'¶

_template = {'Darwin': {'INSTALL.Vendor.Tool': {'InstallationDirectory': '${INSTALL.Vendor:InstallationDirectory}/${Version}/Tool', 'BinaryDirectory': '${InstallationDirectory}/bin'}}, 'Linux': {'INSTALL.Vendor.Tool': {'InstallationDirectory': '${INSTALL.Vendor:InstallationDirectory}/${Version}/Tool', 'BinaryDirectory': '${InstallationDirectory}/bin'}}, 'ALL': {'INSTALL.Vendor.Tool': {'Version': '1.0'}}, 'Windows': {'INSTALL.Vendor.Tool': {'InstallationDirectory': '${INSTALL.Vendor:InstallationDirectory}/${Version}/Tool/', 'BinaryDirectory': '${InstallationDirectory}/bin'}}}¶

class ToolChains.Mentor.ModelSim.ModelSimPEConfiguration(host: Base.IHost)[source]¶

Inheritance

Members

_toolName = 'Mentor ModelSim PE'¶: The name of the tool.

_section = 'INSTALL.Mentor.ModelSimPE'¶: The name of the configuration section. Pattern: INSTALL.Vendor.ToolName.

_template = {'Windows': {'INSTALL.Mentor.ModelSimPE': {'Version': '10.5c', 'SectionName': ('%{PathWithRoot}#${Version}', None), 'InstallationDirectory': ('${${SectionName}:InstallationDirectory}', '${INSTALL.Mentor:InstallationDirectory}/${ToolInstallationName}/${Version}'), 'BinaryDirectory': ('${${SectionName}:BinaryDirectory}', '${InstallationDirectory}/win32pe'), 'ToolInstallationName': 'ModelSim PE', 'Edition': 'ModelSim PE'}}}¶: The template for the configuration sections represented as nested dictionaries.

_ConfigureEdition()[source]¶: Configure ModelSim PE for Mentor Graphics.

CheckDependency()¶: Check if general Mentor Graphics support is configured in PoC.

ClearSection(writeWarnings=False)¶: Clear the configuration section associated to this Configuration class.

ConfigureForAll()¶

Configuration routine for Mentor Graphics ModelSim on all supported platforms.

Ask if ModelSim is installed.

Pass → skip this configuration. Don’t change existing settings.

Yes → collect installation information for ModelSim.

No → clear the ModelSim configuration section.

Ask for ModelSim’s version.
Ask for ModelSim’s edition (PE, PE student, SE 32-bit, SE 64-bit).
Ask for ModelSim’s installation directory.

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.

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)¶

PrepareVersionedSections(writeWarnings=False)¶

RunPostConfigurationTasks()¶

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.

_CheckModelSimVersion(binPath, version)¶

_ConfigureBinaryDirectory()¶: Updates section with value from _template and returns directory as Path object.

_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.

_ConfigureVersion()¶: If no version was configured before, then _GetDefaultVersion is called. Asks for version and updates section. Returns version as string.

_GetDefaultEdition()¶

Returns unresolved default edition (str) from template.

Overwrite this method in a sub-class for automatic search of editions.

_GetDefaultInstallationDirectory()¶

Return unresolved default installation directory (str) from template.

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

_GetDefaultOptionValue(optionName)¶

_GetDefaultVersion()¶

Returns unresolved default version (str) from template.

Overwrite this method in a sub-class for automatic search of version.

_GetModelSimVersion(binPath)¶

_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 = True¶

_vendor = 'Mentor'¶

class ToolChains.Mentor.ModelSim.ModelSimSE32Configuration(host: Base.IHost)[source]¶

Inheritance

Members

_toolName = 'Mentor ModelSim SE 32-bit'¶: The name of the tool.

_section = 'INSTALL.Mentor.ModelSimSE32'¶: The name of the configuration section. Pattern: INSTALL.Vendor.ToolName.

_template = {'Windows': {'INSTALL.Mentor.ModelSimSE32': {'Version': '10.5c', 'SectionName': ('%{PathWithRoot}#${Version}', None), 'InstallationDirectory': ('${${SectionName}:InstallationDirectory}', '${INSTALL.Mentor:InstallationDirectory}/${ToolInstallationName}/${Version}'), 'BinaryDirectory': ('${${SectionName}:BinaryDirectory}', '${InstallationDirectory}/win32'), 'ToolInstallationName': 'ModelSim SE', 'Edition': 'ModelSim SE 32-bit'}}}¶: The template for the configuration sections represented as nested dictionaries.

_ConfigureEdition()[source]¶

CheckDependency()¶: Check if general Mentor Graphics support is configured in PoC.

ClearSection(writeWarnings=False)¶: Clear the configuration section associated to this Configuration class.

ConfigureForAll()¶

Configuration routine for Mentor Graphics ModelSim on all supported platforms.

Ask if ModelSim is installed.

Pass → skip this configuration. Don’t change existing settings.

Yes → collect installation information for ModelSim.

No → clear the ModelSim configuration section.

Ask for ModelSim’s version.
Ask for ModelSim’s edition (PE, PE student, SE 32-bit, SE 64-bit).
Ask for ModelSim’s installation directory.

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.

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)¶

PrepareVersionedSections(writeWarnings=False)¶

RunPostConfigurationTasks()¶

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.

_CheckModelSimVersion(binPath, version)¶

_ConfigureBinaryDirectory()¶: Updates section with value from _template and returns directory as Path object.

_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.

_ConfigureVersion()¶: If no version was configured before, then _GetDefaultVersion is called. Asks for version and updates section. Returns version as string.

_GetDefaultEdition()¶

Returns unresolved default edition (str) from template.

Overwrite this method in a sub-class for automatic search of editions.

_GetDefaultInstallationDirectory()¶

Return unresolved default installation directory (str) from template.

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

_GetDefaultOptionValue(optionName)¶

_GetDefaultVersion()¶

Returns unresolved default version (str) from template.

Overwrite this method in a sub-class for automatic search of version.

_GetModelSimVersion(binPath)¶

_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 = True¶

_vendor = 'Mentor'¶

class ToolChains.Mentor.ModelSim.ModelSimSE64Configuration(host: Base.IHost)[source]¶

Inheritance

Members

_toolName = 'Mentor ModelSim SE 64-bit'¶: The name of the tool.

_section = 'INSTALL.Mentor.ModelSimSE64'¶: The name of the configuration section. Pattern: INSTALL.Vendor.ToolName.

_template = {'Linux': {'INSTALL.Mentor.ModelSimSE64': {'Version': '10.5c', 'SectionName': ('%{PathWithRoot}#${Version}', None), 'InstallationDirectory': ('${${SectionName}:InstallationDirectory}', '${INSTALL.Mentor:InstallationDirectory}/${ToolInstallationName}/${Version}'), 'BinaryDirectory': ('${${SectionName}:BinaryDirectory}', '${InstallationDirectory}/linux_x86_64'), 'ToolInstallationName': 'ModelSim_SE', 'Edition': 'ModelSim SE 64-bit'}}, 'Windows': {'INSTALL.Mentor.ModelSimSE64': {'Version': '10.5c', 'SectionName': ('%{PathWithRoot}#${Version}', None), 'InstallationDirectory': ('${${SectionName}:InstallationDirectory}', '${INSTALL.Mentor:InstallationDirectory}/${ToolInstallationName}/${Version}'), 'BinaryDirectory': ('${${SectionName}:BinaryDirectory}', '${InstallationDirectory}/win64'), 'ToolInstallationName': 'ModelSim SE', 'Edition': 'ModelSim SE 64-bit'}}}¶: The template for the configuration sections represented as nested dictionaries.

_ConfigureEdition()[source]¶

CheckDependency()¶: Check if general Mentor Graphics support is configured in PoC.

ClearSection(writeWarnings=False)¶: Clear the configuration section associated to this Configuration class.

ConfigureForAll()¶

Configuration routine for Mentor Graphics ModelSim on all supported platforms.

Ask if ModelSim is installed.

Pass → skip this configuration. Don’t change existing settings.

Yes → collect installation information for ModelSim.

No → clear the ModelSim configuration section.

Ask for ModelSim’s version.
Ask for ModelSim’s edition (PE, PE student, SE 32-bit, SE 64-bit).
Ask for ModelSim’s installation directory.

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.

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)¶

PrepareVersionedSections(writeWarnings=False)¶

RunPostConfigurationTasks()¶

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.

_CheckModelSimVersion(binPath, version)¶

_ConfigureBinaryDirectory()¶: Updates section with value from _template and returns directory as Path object.

_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.

_ConfigureVersion()¶: If no version was configured before, then _GetDefaultVersion is called. Asks for version and updates section. Returns version as string.

_GetDefaultEdition()¶

Returns unresolved default edition (str) from template.

Overwrite this method in a sub-class for automatic search of editions.

_GetDefaultInstallationDirectory()¶

Return unresolved default installation directory (str) from template.

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

_GetDefaultOptionValue(optionName)¶

_GetDefaultVersion()¶

Returns unresolved default version (str) from template.

Overwrite this method in a sub-class for automatic search of version.

_GetModelSimVersion(binPath)¶

_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 = True¶

_vendor = 'Mentor'¶

class ToolChains.Mentor.ModelSim.Selector(host: Base.IHost)[source]¶

Inheritance

Members

_toolName = 'ModelSim'¶

Select()[source]¶

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.

ToolName¶

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

_AskSelection(editions, defaultEdition)¶

_AskYes_NoPass(question, indent=1)¶: Ask a yes/NO/pass question.

_Ask_YesNoPass(question, indent=1)¶: Ask a YES/no/pass question.

_GetConfiguredEditions(editions)¶: Return all configured editions.

_PrintAvailableEditions(editions, selectedEdition)¶: Print all available editions and return the selected index.

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