pyIPCMI.ToolChain.Intel.ModelSim.py

Exceptions

• ModelSimException: Base class for all tool specific exceptions

Classes

• IntelModelSimEditions: An enumeration.
• Configuration: Base class for all tool Configuration classes.
• IntelEditionConfiguration: Base class for all tool Configuration classes.
• IntelStarterEditionConfiguration: Base class for all tool Configuration classes.

exception pyIPCMI.ToolChain.Intel.ModelSim.ModelSimException(message='')

Inheritance

Members

__init__(message='')

Exception initializer

Parameters:message (str) – The exception message.

__str__()

Returns the exception’s message text.

args

class pyIPCMI.ToolChain.Intel.ModelSim.IntelModelSimEditions(name, section)

An enumeration.

Inheritance

Members

ModelSimIntelEdition = 1

ModelSimIntelStarterEdition = 2

class pyIPCMI.ToolChain.Intel.ModelSim.Configuration(host: pyIPCMI.Base.IHost)

Inheritance

Members

_vendor = 'Intel'

The name of the tools vendor.

_multiVersionSupport = False

Intel ModelSim Edition doesn’t support multiple versions.

CheckDependency()

Check if general Intel support is configured in pyIPCMI.

ConfigureForAll()

Configuration routine for Mentor Graphics ModelSim on all supported platforms.

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

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

_ConfigureEdition()

Configure ModelSim for Intel.

ClearSection(writeWarnings=False)

Clear the configuration section associated to this 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)

PrepareVersionedSections(writeWarnings=False)

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.

_CheckModelSimVersion(binPath, version)

_Configuration__GetModelSimVersion(binPath)

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

_section = 'INSTALL.Vendor.Tool'

_template = {'ALL': {'INSTALL.Vendor.Tool': {'Version': '1.0'}}, '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'}}, 'Windows': {'INSTALL.Vendor.Tool': {'InstallationDirectory': '${INSTALL.Vendor:InstallationDirectory}/${Version}/Tool/', 'BinaryDirectory': '${InstallationDirectory}/bin'}}}

_toolName = 'Mentor ModelSim'

class pyIPCMI.ToolChain.Intel.ModelSim.IntelEditionConfiguration(host: pyIPCMI.Base.IHost)

Inheritance

Members

_toolName = 'Intel ModelSim'

The name of the tool.

__editionName = None

The name of the tool.

_section = 'INSTALL.Intel.ModelSimAE'

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

_template = {'Linux': {'INSTALL.Intel.ModelSimAE': {'AdditionalVSimOptions': '', 'AdditionalVComOptions': '', 'Edition': 'ModelSim Intel Edition', 'Version': '10.5b', 'InstallationDirectory': '${INSTALL.Intel:InstallationDirectory}/${INSTALL.Intel.Quartus:Version}/modelsim_ae', 'BinaryDirectory': '${InstallationDirectory}/linuxaloem'}}, 'Windows': {'INSTALL.Intel.ModelSimAE': {'AdditionalVSimOptions': '', 'AdditionalVComOptions': '', 'Edition': 'ModelSim Intel Edition', 'Version': '10.5b', 'InstallationDirectory': '${INSTALL.Intel:InstallationDirectory}/${INSTALL.Intel.Quartus:Version}/modelsim_ae', 'BinaryDirectory': '${InstallationDirectory}/win32aloem'}}}

CheckDependency()

Check if general Intel support is configured in pyIPCMI.

ClearSection(writeWarnings=False)

Clear the configuration section associated to this Configuration class.

ConfigureForAll()

Configuration routine for Mentor Graphics ModelSim on all supported platforms.

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

1. Ask for ModelSim’s version.
2. Ask for ModelSim’s edition (PE, PE student, SE 32-bit, SE 64-bit).
3. 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.

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)

PrepareVersionedSections(writeWarnings=False)

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.

_CheckModelSimVersion(binPath, version)

_Configuration__GetModelSimVersion(binPath)

_ConfigureBinaryDirectory()

Updates section with value from _template and returns directory as Path object.

_ConfigureEdition()

Configure ModelSim for Intel.

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

_IntelEditionConfiguration__editionName = 'ModelSim Intel Edition'

_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

_vendor = 'Intel'

class pyIPCMI.ToolChain.Intel.ModelSim.IntelStarterEditionConfiguration(host: pyIPCMI.Base.IHost)

Inheritance

Members

_toolName = 'Intel ModelSim (Starter Edition)'

The name of the tool.

__editionName = None

_section = 'INSTALL.Intel.ModelSimASE'

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

_template = {'Linux': {'INSTALL.Intel.ModelSimASE': {'AdditionalVSimOptions': '', 'AdditionalVComOptions': '', 'Edition': 'ModelSim Intel Starter Edition', 'Version': '10.5b', 'InstallationDirectory': '${INSTALL.Intel:InstallationDirectory}/${INSTALL.Intel.Quartus:Version}/modelsim_ase', 'BinaryDirectory': '${InstallationDirectory}/linuxaloem'}}, 'Windows': {'INSTALL.Intel.ModelSimASE': {'AdditionalVSimOptions': '', 'AdditionalVComOptions': '', 'Edition': 'ModelSim Intel Starter Edition', 'Version': '10.5b', 'InstallationDirectory': '${INSTALL.Intel:InstallationDirectory}/${INSTALL.Intel.Quartus:Version}/modelsim_ase', 'BinaryDirectory': '${InstallationDirectory}/win32aloem'}}}

CheckDependency()

Check if general Intel support is configured in pyIPCMI.

ClearSection(writeWarnings=False)

Clear the configuration section associated to this Configuration class.

ConfigureForAll()

Configuration routine for Mentor Graphics ModelSim on all supported platforms.

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

1. Ask for ModelSim’s version.
2. Ask for ModelSim’s edition (PE, PE student, SE 32-bit, SE 64-bit).
3. 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.

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)

PrepareVersionedSections(writeWarnings=False)

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.

_CheckModelSimVersion(binPath, version)

_Configuration__GetModelSimVersion(binPath)

_ConfigureBinaryDirectory()

Updates section with value from _template and returns directory as Path object.

_ConfigureEdition()

Configure ModelSim for Intel.

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

_IntelStarterEditionConfiguration__editionName = 'ModelSim Intel Starter Edition'

_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

_vendor = 'Intel'