.. _r-3a3aosvvm: .. _r-osvvm: ::osvvm ******* .. _r-3a3aosvvmqzCommands: .. _r-osvvm-commands: .. index:: single: analyze .. index:: single: osvvm namespace;analyze .. _r-3a3aosvvm3a3aanalyze: analyze ----------- Analyze an HDL source file. .. parsed-literal:: **analyze** *FileName ?args?* .. rubric:: Parameters :FileName: Path to the HDL source file. :args: Further options. .. rubric:: Description This procedure executes a tool-specific analyze command depending on what tool was detected. Some of the used analyze option depend on the current context. For example the use VHDL library this source file and its design units are compiled into, depend on the last :ref:`library ` call. **Procedures influencing the context for the ``analyze`` command:** - :ref:`library ` - set the VHDl working library - :ref:`SetVHDLVersion ` - tbd - :ref:`SetExtendedAnalyzeOptions ` - tbd - :ref:`SetVhdlAnalyzeOptions ` - tbd **Supported HDL sourcefile languages:** - VHDL ``*.vhd``/``*.vhdl`` - Verilog ``*.v`` - SystemVerilog ``*.sv`` .. index:: single: build .. index:: single: osvvm namespace;build .. _r-3a3aosvvm3a3abuild: build --------- .. parsed-literal:: **build** *?Path_Or_File? ?args?* .. rubric:: Parameters :Path_Or_File: Not documented. Optional, default ``.``. .. index:: single: BuildName .. index:: single: osvvm namespace;BuildName .. _r-3a3aosvvm3a3aBuildName: BuildName ------------- .. parsed-literal:: **BuildName** *ParamBuildName* .. rubric:: Parameters :ParamBuildName: Not documented. .. index:: single: ChangeWorkingDirectory .. index:: single: osvvm namespace;ChangeWorkingDirectory .. _r-3a3aosvvm3a3aChangeWorkingDirectory: ChangeWorkingDirectory -------------------------- .. parsed-literal:: **ChangeWorkingDirectory** *RelativePath* .. rubric:: Parameters :RelativePath: Not documented. .. index:: single: CoSim .. index:: single: osvvm namespace;CoSim .. _r-3a3aosvvm3a3aCoSim: CoSim --------- .. parsed-literal:: **CoSim** .. index:: single: CreateAnalyzeOrderCsv .. index:: single: osvvm namespace;CreateAnalyzeOrderCsv .. _r-3a3aosvvm3a3aCreateAnalyzeOrderCsv: CreateAnalyzeOrderCsv ------------------------- CreateAnalyzeOrderCsv runs a build script in DryRunMode and creates a AnalyzeOrder.csv file. .. parsed-literal:: **CreateAnalyzeOrderCsv** *ProFileToBuild ?FileNameAndPath?* .. rubric:: Parameters :ProFileToBuild: Path to the pro file that build the entire design. :FileNameAndPath: Name of file to create. Default: ./AnalyzeOrder.csv Optional, default ``./AnalyzeOrder.csv``. .. index:: single: CreateDirectory .. index:: single: osvvm namespace;CreateDirectory .. _r-3a3aosvvm3a3aCreateDirectory: CreateDirectory ------------------- .. parsed-literal:: **CreateDirectory** *Directory* .. rubric:: Parameters :Directory: Not documented. .. index:: single: CreateDryRunDict .. index:: single: osvvm namespace;CreateDryRunDict .. _r-3a3aosvvm3a3aCreateDryRunDict: CreateDryRunDict -------------------- CreateDryRunDict runs a build script in DryRunMode and creates dictionaries and lists of Analyze and Simulate information. The Analyze dictionary, ::osvvm::AnalyzeDict, has a dictionary for each library used. For each library there is an list of dictionaries that contain the file analyzed as well as language version used. The list, ::osvvm::AnalyzeOrderList, has a list of dictionaries that contain the file name, library, and vhdl version. The Simulation dictionary, ::osvvm::SimulateDict, has a dictionary for each library used. For each library there is an list of dictionaries that contain information passed to simulate. .. parsed-literal:: **CreateDryRunDict** *ProFileToBuild* .. rubric:: Parameters :ProFileToBuild: Path to the pro file that build the entire design. :WhereToCreate: Directory into which to create vhdl_ls.toml. Default = . .. index:: single: CreateLibraryPath .. index:: single: osvvm namespace;CreateLibraryPath .. _r-3a3aosvvm3a3aCreateLibraryPath: CreateLibraryPath --------------------- .. parsed-literal:: **CreateLibraryPath** *PathToLib* .. rubric:: Parameters :PathToLib: Not documented. .. index:: single: CreateOsvvmScriptSettingsPkg .. index:: single: osvvm namespace;CreateOsvvmScriptSettingsPkg .. _r-3a3aosvvm3a3aCreateOsvvmScriptSettingsPkg: CreateOsvvmScriptSettingsPkg -------------------------------- .. parsed-literal:: **CreateOsvvmScriptSettingsPkg** *SettingsDirectory* .. rubric:: Parameters :SettingsDirectory: Not documented. .. index:: single: CreateTestCaseCommonPkg .. index:: single: osvvm namespace;CreateTestCaseCommonPkg .. _r-3a3aosvvm3a3aCreateTestCaseCommonPkg: CreateTestCaseCommonPkg --------------------------- set CurrentDir "" .. parsed-literal:: **CreateTestCaseCommonPkg** *?PackageName? ?ValidatedResults?* .. rubric:: Parameters :PackageName: Not documented. Optional, default ``TestCaseCommonPkg``. :ValidatedResults: Not documented. Optional, default ``../ValidatedResults``. .. index:: single: CreateVhdlLsToml .. index:: single: osvvm namespace;CreateVhdlLsToml .. _r-3a3aosvvm3a3aCreateVhdlLsToml: CreateVhdlLsToml -------------------- CreateVhdlLsToml runs a build script in DryRunMode and creates a vhdl_ls.toml file. .. parsed-literal:: **CreateVhdlLsToml** *ProFileToBuild ?FileNameAndPath?* .. rubric:: Parameters :ProFileToBuild: Path to the pro file that build the entire design. :FileNameAndPath: Name of file to create. Default: ./vhdl_ls.toml Optional, default ``./vhdl_ls.toml``. .. index:: single: DirectoryExists .. index:: single: osvvm namespace;DirectoryExists .. _r-3a3aosvvm3a3aDirectoryExists: DirectoryExists ------------------- .. parsed-literal:: **DirectoryExists** *DirInQuestion* .. rubric:: Parameters :DirInQuestion: Not documented. .. index:: single: DoWaves .. index:: single: osvvm namespace;DoWaves .. _r-3a3aosvvm3a3aDoWaves: DoWaves ----------- .. parsed-literal:: **DoWaves** *?args?* .. rubric:: Parameters .. index:: single: EndSimulation .. index:: single: osvvm namespace;EndSimulation .. _r-3a3aosvvm3a3aEndSimulation: EndSimulation ----------------- .. parsed-literal:: **EndSimulation** .. index:: single: FileExists .. index:: single: osvvm namespace;FileExists .. _r-3a3aosvvm3a3aFileExists: FileExists -------------- .. parsed-literal:: **FileExists** *FileName* .. rubric:: Parameters :FileName: Not documented. .. index:: single: FileModified .. index:: single: osvvm namespace;FileModified .. _r-3a3aosvvm3a3aFileModified: FileModified ---------------- .. parsed-literal:: **FileModified** *FileName* .. rubric:: Parameters :FileName: Not documented. .. index:: single: FindExistingLibraryPath .. index:: single: osvvm namespace;FindExistingLibraryPath .. _r-3a3aosvvm3a3aFindExistingLibraryPath: FindExistingLibraryPath --------------------------- .. parsed-literal:: **FindExistingLibraryPath** *PathToLib* .. rubric:: Parameters :PathToLib: Not documented. .. index:: single: FindIncludeFile .. index:: single: osvvm namespace;FindIncludeFile .. _r-3a3aosvvm3a3aFindIncludeFile: FindIncludeFile ------------------- .. parsed-literal:: **FindIncludeFile** *Path_Or_File* .. rubric:: Parameters :Path_Or_File: Not documented. .. index:: single: FindLibraryPath .. index:: single: osvvm namespace;FindLibraryPath .. _r-3a3aosvvm3a3aFindLibraryPath: FindLibraryPath ------------------- .. parsed-literal:: **FindLibraryPath** *PathToLib* .. rubric:: Parameters :PathToLib: Not documented. .. index:: single: FindLibraryPathByName .. index:: single: osvvm namespace;FindLibraryPathByName .. _r-3a3aosvvm3a3aFindLibraryPathByName: FindLibraryPathByName ------------------------- .. parsed-literal:: **FindLibraryPathByName** *LibraryName* .. rubric:: Parameters :LibraryName: Not documented. .. index:: single: FindOsvvmSettingsDirectory .. index:: single: osvvm namespace;FindOsvvmSettingsDirectory .. _r-3a3aosvvm3a3aFindOsvvmSettingsDirectory: FindOsvvmSettingsDirectory ------------------------------ When StartUpShared.tcl calls this to determine the value of ::osvvm::OsvvmUserSettingsDirectory, OsvvmSettingsLocal.tcl has not been run yet, as a result, .. parsed-literal:: **FindOsvvmSettingsDirectory** *?OsvvmSubdirectory?* .. rubric:: Parameters :OsvvmSubdirectory: Not documented. Optional, default ``osvvm``. .. rubric:: Description - OsvvmSettingsSubdirectory will have its default value of "" and - SettingsAreRelativeToSimulationDirectory will have its default value of false. For OsvvmSettingsSubdirectory, this is ok as it is only needed to differentiate the VHDL code and not the settings. SettingsAreRelativeToSimulationDirectory this is not ok and it usage has been deprecated. This was used to differentiate VHDL sources for different simulators - use OsvvmSettingsSubdirectory instead .. index:: single: generic .. index:: single: osvvm namespace;generic .. _r-3a3aosvvm3a3ageneric: generic ----------- .. parsed-literal:: **generic** *Name Value* .. rubric:: Parameters :Name: Not documented. :Value: Not documented. .. index:: single: GetCoverageAnalyzeEnable .. index:: single: osvvm namespace;GetCoverageAnalyzeEnable .. _r-3a3aosvvm3a3aGetCoverageAnalyzeEnable: GetCoverageAnalyzeEnable ---------------------------- .. parsed-literal:: **GetCoverageAnalyzeEnable** .. index:: single: GetCoverageAnalyzeOptions .. index:: single: osvvm namespace;GetCoverageAnalyzeOptions .. _r-3a3aosvvm3a3aGetCoverageAnalyzeOptions: GetCoverageAnalyzeOptions ----------------------------- .. parsed-literal:: **GetCoverageAnalyzeOptions** .. index:: single: GetCoverageEnable .. index:: single: osvvm namespace;GetCoverageEnable .. _r-3a3aosvvm3a3aGetCoverageEnable: GetCoverageEnable --------------------- .. parsed-literal:: **GetCoverageEnable** .. index:: single: GetCoverageSimulateEnable .. index:: single: osvvm namespace;GetCoverageSimulateEnable .. _r-3a3aosvvm3a3aGetCoverageSimulateEnable: GetCoverageSimulateEnable ----------------------------- .. parsed-literal:: **GetCoverageSimulateEnable** .. index:: single: GetCoverageSimulateOptions .. index:: single: osvvm namespace;GetCoverageSimulateOptions .. _r-3a3aosvvm3a3aGetCoverageSimulateOptions: GetCoverageSimulateOptions ------------------------------ .. parsed-literal:: **GetCoverageSimulateOptions** .. index:: single: GetDebugMode .. index:: single: osvvm namespace;GetDebugMode .. _r-3a3aosvvm3a3aGetDebugMode: GetDebugMode ---------------- .. parsed-literal:: **GetDebugMode** .. index:: single: GetExtendedAnalyzeOptions .. index:: single: osvvm namespace;GetExtendedAnalyzeOptions .. _r-3a3aosvvm3a3aGetExtendedAnalyzeOptions: GetExtendedAnalyzeOptions ----------------------------- .. parsed-literal:: **GetExtendedAnalyzeOptions** .. index:: single: GetExtendedElaborateOptions .. index:: single: osvvm namespace;GetExtendedElaborateOptions .. _r-3a3aosvvm3a3aGetExtendedElaborateOptions: GetExtendedElaborateOptions ------------------------------- .. parsed-literal:: **GetExtendedElaborateOptions** .. index:: single: GetExtendedOptimizeOptions .. index:: single: osvvm namespace;GetExtendedOptimizeOptions .. _r-3a3aosvvm3a3aGetExtendedOptimizeOptions: GetExtendedOptimizeOptions ------------------------------ .. parsed-literal:: **GetExtendedOptimizeOptions** .. index:: single: GetExtendedRunOptions .. index:: single: osvvm namespace;GetExtendedRunOptions .. _r-3a3aosvvm3a3aGetExtendedRunOptions: GetExtendedRunOptions ------------------------- .. parsed-literal:: **GetExtendedRunOptions** .. index:: single: GetExtendedSimulateOptions .. index:: single: osvvm namespace;GetExtendedSimulateOptions .. _r-3a3aosvvm3a3aGetExtendedSimulateOptions: GetExtendedSimulateOptions ------------------------------ .. parsed-literal:: **GetExtendedSimulateOptions** .. index:: single: GetInteractiveMode .. index:: single: osvvm namespace;GetInteractiveMode .. _r-3a3aosvvm3a3aGetInteractiveMode: GetInteractiveMode ---------------------- .. parsed-literal:: **GetInteractiveMode** .. index:: single: GetLibraryDirectory .. index:: single: osvvm namespace;GetLibraryDirectory .. _r-3a3aosvvm3a3aGetLibraryDirectory: GetLibraryDirectory ----------------------- .. parsed-literal:: **GetLibraryDirectory** .. index:: single: GetLogSignals .. index:: single: osvvm namespace;GetLogSignals .. _r-3a3aosvvm3a3aGetLogSignals: GetLogSignals ----------------- .. parsed-literal:: **GetLogSignals** .. index:: single: GetSaveWaves .. index:: single: osvvm namespace;GetSaveWaves .. _r-3a3aosvvm3a3aGetSaveWaves: GetSaveWaves ---------------- .. parsed-literal:: **GetSaveWaves** .. index:: single: GetSecondSimulationTopLevel .. index:: single: osvvm namespace;GetSecondSimulationTopLevel .. _r-3a3aosvvm3a3aGetSecondSimulationTopLevel: GetSecondSimulationTopLevel ------------------------------- .. parsed-literal:: **GetSecondSimulationTopLevel** .. index:: single: GetSimulatorResolution .. index:: single: osvvm namespace;GetSimulatorResolution .. _r-3a3aosvvm3a3aGetSimulatorResolution: GetSimulatorResolution -------------------------- .. parsed-literal:: **GetSimulatorResolution** .. index:: single: GetTimeString .. index:: single: osvvm namespace;GetTimeString .. _r-3a3aosvvm3a3aGetTimeString: GetTimeString ----------------- .. parsed-literal:: **GetTimeString** .. index:: single: GetTranscriptType .. index:: single: osvvm namespace;GetTranscriptType .. _r-3a3aosvvm3a3aGetTranscriptType: GetTranscriptType --------------------- .. parsed-literal:: **GetTranscriptType** .. index:: single: GetVerilogAnalyzeOptions .. index:: single: osvvm namespace;GetVerilogAnalyzeOptions .. _r-3a3aosvvm3a3aGetVerilogAnalyzeOptions: GetVerilogAnalyzeOptions ---------------------------- .. parsed-literal:: **GetVerilogAnalyzeOptions** .. index:: single: GetVhdlAnalyzeOptions .. index:: single: osvvm namespace;GetVhdlAnalyzeOptions .. _r-3a3aosvvm3a3aGetVhdlAnalyzeOptions: GetVhdlAnalyzeOptions ------------------------- .. parsed-literal:: **GetVhdlAnalyzeOptions** .. index:: single: GetVHDLVersion .. index:: single: osvvm namespace;GetVHDLVersion .. _r-3a3aosvvm3a3aGetVHDLVersion: GetVHDLVersion ------------------ .. parsed-literal:: **GetVHDLVersion** .. index:: single: include .. index:: single: osvvm namespace;include .. _r-3a3aosvvm3a3ainclude: include ----------- .. parsed-literal:: **include** *Path_Or_File ?args?* .. rubric:: Parameters :Path_Or_File: Not documented. .. index:: single: IterateFile .. index:: single: osvvm namespace;IterateFile .. _r-3a3aosvvm3a3aIterateFile: IterateFile --------------- puts "``$FileWithNames``" .. parsed-literal:: **IterateFile** *FileWithNames ActionForName* .. rubric:: Parameters :FileWithNames: Not documented. :ActionForName: Not documented. .. index:: single: JoinWorkingDirectory .. index:: single: osvvm namespace;JoinWorkingDirectory .. _r-3a3aosvvm3a3aJoinWorkingDirectory: JoinWorkingDirectory ------------------------ .. parsed-literal:: **JoinWorkingDirectory** *RelativePath* .. rubric:: Parameters :RelativePath: Not documented. .. index:: single: library .. index:: single: osvvm namespace;library .. _r-3a3aosvvm3a3alibrary: library ----------- .. parsed-literal:: **library** *LibraryName ?PathToLib?* .. rubric:: Parameters :LibraryName: Not documented. :PathToLib: Not documented. Optional, default ``""``. .. index:: single: LinkCurrentLibraries .. index:: single: osvvm namespace;LinkCurrentLibraries .. _r-3a3aosvvm3a3aLinkCurrentLibraries: LinkCurrentLibraries ------------------------ .. parsed-literal:: **LinkCurrentLibraries** .. index:: single: LinkLibrary .. index:: single: osvvm namespace;LinkLibrary .. _r-3a3aosvvm3a3aLinkLibrary: LinkLibrary --------------- .. parsed-literal:: **LinkLibrary** *LibraryName ?PathToLib?* .. rubric:: Parameters :LibraryName: Not documented. :PathToLib: Not documented. Optional, default ``""``. .. index:: single: LinkLibraryDirectory .. index:: single: osvvm namespace;LinkLibraryDirectory .. _r-3a3aosvvm3a3aLinkLibraryDirectory: LinkLibraryDirectory ------------------------ .. parsed-literal:: **LinkLibraryDirectory** *?LibraryDirectory?* .. rubric:: Parameters :LibraryDirectory: Not documented. Optional, default ``""``. .. index:: single: ListLibraries .. index:: single: osvvm namespace;ListLibraries .. _r-3a3aosvvm3a3aListLibraries: ListLibraries ----------------- .. parsed-literal:: **ListLibraries** .. index:: single: MergeCoverage .. index:: single: osvvm namespace;MergeCoverage .. _r-3a3aosvvm3a3aMergeCoverage: MergeCoverage ----------------- .. parsed-literal:: **MergeCoverage** *SuiteName MergeName* .. rubric:: Parameters :SuiteName: Not documented. :MergeName: Not documented. .. index:: single: NoNullRangeWarning .. index:: single: osvvm namespace;NoNullRangeWarning .. _r-3a3aosvvm3a3aNoNullRangeWarning: NoNullRangeWarning ---------------------- .. parsed-literal:: **NoNullRangeWarning** .. index:: single: OpenBuildHtml .. index:: single: osvvm namespace;OpenBuildHtml .. _r-3a3aosvvm3a3aOpenBuildHtml: OpenBuildHtml ----------------- .. parsed-literal:: **OpenBuildHtml** *?ParamBuildName?* .. rubric:: Parameters :ParamBuildName: Not documented. Optional, default ``""``. .. index:: single: OpenIndex .. index:: single: osvvm namespace;OpenIndex .. _r-3a3aosvvm3a3aOpenIndex: OpenIndex ------------- .. parsed-literal:: **OpenIndex** .. index:: single: OsvvmLibraryPath .. index:: single: osvvm namespace;OsvvmLibraryPath .. _r-3a3aosvvm3a3aOsvvmLibraryPath: OsvvmLibraryPath -------------------- Make sure ``$PathToLib`` ends with VhdlLibraryDirectory/VhdlLibrarySubdirectory If it does not, fix it so it does. .. parsed-literal:: **OsvvmLibraryPath** *PathToLib* .. rubric:: Parameters :PathToLib: Not documented. .. index:: single: RemoveAllLibraries .. index:: single: osvvm namespace;RemoveAllLibraries .. _r-3a3aosvvm3a3aRemoveAllLibraries: RemoveAllLibraries ---------------------- .. parsed-literal:: **RemoveAllLibraries** .. index:: single: RemoveLibrary .. index:: single: osvvm namespace;RemoveLibrary .. _r-3a3aosvvm3a3aRemoveLibrary: RemoveLibrary ----------------- .. parsed-literal:: **RemoveLibrary** *LibraryName ?PathToLib?* .. rubric:: Parameters :LibraryName: Not documented. :PathToLib: Not documented. Optional, default ``""``. .. index:: single: RemoveLibraryDirectory .. index:: single: osvvm namespace;RemoveLibraryDirectory .. _r-3a3aosvvm3a3aRemoveLibraryDirectory: RemoveLibraryDirectory -------------------------- .. parsed-literal:: **RemoveLibraryDirectory** *?PathToLib?* .. rubric:: Parameters :PathToLib: Not documented. Optional, default ``""``. .. index:: single: RemoveLocalLibraries .. index:: single: osvvm namespace;RemoveLocalLibraries .. _r-3a3aosvvm3a3aRemoveLocalLibraries: RemoveLocalLibraries ------------------------ .. parsed-literal:: **RemoveLocalLibraries** .. index:: single: RunAllTests .. index:: single: osvvm namespace;RunAllTests .. _r-3a3aosvvm3a3aRunAllTests: RunAllTests --------------- .. parsed-literal:: **RunAllTests** *?TestFilePrefix? ?args?* .. rubric:: Parameters :TestFilePrefix: Not documented. Optional, default ``""``. .. index:: single: RunTest .. index:: single: osvvm namespace;RunTest .. _r-3a3aosvvm3a3aRunTest: RunTest ----------- .. parsed-literal:: **RunTest** *FileName ?SimName? ?args?* .. rubric:: Parameters :FileName: Not documented. :SimName: Not documented. Optional, default ``""``. .. index:: single: SetCoverageAnalyzeEnable .. index:: single: osvvm namespace;SetCoverageAnalyzeEnable .. _r-3a3aosvvm3a3aSetCoverageAnalyzeEnable: SetCoverageAnalyzeEnable ---------------------------- .. parsed-literal:: **SetCoverageAnalyzeEnable** *?Enable?* .. rubric:: Parameters :Enable: Not documented. Optional, default ``true``. .. index:: single: SetCoverageAnalyzeOptions .. index:: single: osvvm namespace;SetCoverageAnalyzeOptions .. _r-3a3aosvvm3a3aSetCoverageAnalyzeOptions: SetCoverageAnalyzeOptions ----------------------------- .. parsed-literal:: **SetCoverageAnalyzeOptions** *?Options?* .. rubric:: Parameters :Options: Not documented. Optional, default ``""``. .. index:: single: SetCoverageEnable .. index:: single: osvvm namespace;SetCoverageEnable .. _r-3a3aosvvm3a3aSetCoverageEnable: SetCoverageEnable --------------------- .. parsed-literal:: **SetCoverageEnable** *?Enable?* .. rubric:: Parameters :Enable: Not documented. Optional, default ``true``. .. index:: single: SetCoverageSimulateEnable .. index:: single: osvvm namespace;SetCoverageSimulateEnable .. _r-3a3aosvvm3a3aSetCoverageSimulateEnable: SetCoverageSimulateEnable ----------------------------- .. parsed-literal:: **SetCoverageSimulateEnable** *?Enable?* .. rubric:: Parameters :Enable: Not documented. Optional, default ``true``. .. index:: single: SetCoverageSimulateOptions .. index:: single: osvvm namespace;SetCoverageSimulateOptions .. _r-3a3aosvvm3a3aSetCoverageSimulateOptions: SetCoverageSimulateOptions ------------------------------ .. parsed-literal:: **SetCoverageSimulateOptions** *?Options?* .. rubric:: Parameters :Options: Not documented. Optional, default ``""``. .. index:: single: SetDebugMode .. index:: single: osvvm namespace;SetDebugMode .. _r-3a3aosvvm3a3aSetDebugMode: SetDebugMode ---------------- .. parsed-literal:: **SetDebugMode** *?Options?* .. rubric:: Parameters :Options: Not documented. Optional, default ``true``. .. index:: single: SetExtendedAnalyzeOptions .. index:: single: osvvm namespace;SetExtendedAnalyzeOptions .. _r-3a3aosvvm3a3aSetExtendedAnalyzeOptions: SetExtendedAnalyzeOptions ----------------------------- .. parsed-literal:: **SetExtendedAnalyzeOptions** *?Options?* .. rubric:: Parameters :Options: Not documented. Optional, default ``""``. .. index:: single: SetExtendedElaborateOptions .. index:: single: osvvm namespace;SetExtendedElaborateOptions .. _r-3a3aosvvm3a3aSetExtendedElaborateOptions: SetExtendedElaborateOptions ------------------------------- .. parsed-literal:: **SetExtendedElaborateOptions** *?Options?* .. rubric:: Parameters :Options: Not documented. Optional, default ``""``. .. index:: single: SetExtendedOptimizeOptions .. index:: single: osvvm namespace;SetExtendedOptimizeOptions .. _r-3a3aosvvm3a3aSetExtendedOptimizeOptions: SetExtendedOptimizeOptions ------------------------------ .. parsed-literal:: **SetExtendedOptimizeOptions** *?Options?* .. rubric:: Parameters :Options: Not documented. Optional, default ``""``. .. index:: single: SetExtendedRunOptions .. index:: single: osvvm namespace;SetExtendedRunOptions .. _r-3a3aosvvm3a3aSetExtendedRunOptions: SetExtendedRunOptions ------------------------- .. parsed-literal:: **SetExtendedRunOptions** *?Options?* .. rubric:: Parameters :Options: Not documented. Optional, default ``""``. .. index:: single: SetExtendedSimulateOptions .. index:: single: osvvm namespace;SetExtendedSimulateOptions .. _r-3a3aosvvm3a3aSetExtendedSimulateOptions: SetExtendedSimulateOptions ------------------------------ .. parsed-literal:: **SetExtendedSimulateOptions** *?Options?* .. rubric:: Parameters :Options: Not documented. Optional, default ``""``. .. index:: single: SetInteractiveMode .. index:: single: osvvm namespace;SetInteractiveMode .. _r-3a3aosvvm3a3aSetInteractiveMode: SetInteractiveMode ---------------------- .. parsed-literal:: **SetInteractiveMode** *?Options?* .. rubric:: Parameters :Options: Not documented. Optional, default ``true``. .. index:: single: SetLibraryDirectory .. index:: single: osvvm namespace;SetLibraryDirectory .. _r-3a3aosvvm3a3aSetLibraryDirectory: SetLibraryDirectory ----------------------- .. parsed-literal:: **SetLibraryDirectory** *?LibraryDirectory?* .. rubric:: Parameters :LibraryDirectory: Not documented. Optional, default ``.``. .. index:: single: SetLogSignals .. index:: single: osvvm namespace;SetLogSignals .. _r-3a3aosvvm3a3aSetLogSignals: SetLogSignals ----------------- .. parsed-literal:: **SetLogSignals** *?Options?* .. rubric:: Parameters :Options: Not documented. Optional, default ``true``. .. index:: single: SetSaveWaves .. index:: single: osvvm namespace;SetSaveWaves .. _r-3a3aosvvm3a3aSetSaveWaves: SetSaveWaves ---------------- .. parsed-literal:: **SetSaveWaves** *?Options?* .. rubric:: Parameters :Options: Not documented. Optional, default ``true``. .. index:: single: SetSecondSimulationTopLevel .. index:: single: osvvm namespace;SetSecondSimulationTopLevel .. _r-3a3aosvvm3a3aSetSecondSimulationTopLevel: SetSecondSimulationTopLevel ------------------------------- .. parsed-literal:: **SetSecondSimulationTopLevel** *?LibraryDotDesignUnit?* .. rubric:: Parameters :LibraryDotDesignUnit: Not documented. Optional, default ``""``. .. index:: single: SetSimulatorResolution .. index:: single: osvvm namespace;SetSimulatorResolution .. _r-3a3aosvvm3a3aSetSimulatorResolution: SetSimulatorResolution -------------------------- .. parsed-literal:: **SetSimulatorResolution** *SimulatorResolution* .. rubric:: Parameters :SimulatorResolution: Not documented. .. index:: single: SetTranscriptType .. index:: single: osvvm namespace;SetTranscriptType .. _r-3a3aosvvm3a3aSetTranscriptType: SetTranscriptType --------------------- .. parsed-literal:: **SetTranscriptType** *?TranscriptType?* .. rubric:: Parameters :TranscriptType: Not documented. Optional, default ``html``. .. index:: single: SetVerilogAnalyzeOptions .. index:: single: osvvm namespace;SetVerilogAnalyzeOptions .. _r-3a3aosvvm3a3aSetVerilogAnalyzeOptions: SetVerilogAnalyzeOptions ---------------------------- .. parsed-literal:: **SetVerilogAnalyzeOptions** *?Options?* .. rubric:: Parameters :Options: Not documented. Optional, default ``""``. .. index:: single: SetVhdlAnalyzeOptions .. index:: single: osvvm namespace;SetVhdlAnalyzeOptions .. _r-3a3aosvvm3a3aSetVhdlAnalyzeOptions: SetVhdlAnalyzeOptions ------------------------- .. parsed-literal:: **SetVhdlAnalyzeOptions** *?Options?* .. rubric:: Parameters :Options: Not documented. Optional, default ``""``. .. index:: single: SetVHDLVersion .. index:: single: osvvm namespace;SetVHDLVersion .. _r-3a3aosvvm3a3aSetVHDLVersion: SetVHDLVersion ------------------ .. parsed-literal:: **SetVHDLVersion** *Version* .. rubric:: Parameters :Version: Not documented. .. index:: single: simulate .. index:: single: osvvm namespace;simulate .. _r-3a3aosvvm3a3asimulate: simulate ------------ .. parsed-literal:: **simulate** *LibraryUnit ?args?* .. rubric:: Parameters :LibraryUnit: Not documented. .. index:: single: SkipTest .. index:: single: osvvm namespace;SkipTest .. _r-3a3aosvvm3a3aSkipTest: SkipTest ------------ .. parsed-literal:: **SkipTest** *?FileName? ?Reason?* .. rubric:: Parameters :FileName: Not documented. Optional, default ``NotProvided.vhd``. :Reason: Not documented. Optional, default ``Not Provided``. .. index:: single: StartTranscript .. index:: single: osvvm namespace;StartTranscript .. _r-3a3aosvvm3a3aStartTranscript: StartTranscript ------------------- .. parsed-literal:: **StartTranscript** .. index:: single: StopTranscript .. index:: single: osvvm namespace;StopTranscript .. _r-3a3aosvvm3a3aStopTranscript: StopTranscript ------------------ .. parsed-literal:: **StopTranscript** *?FileBaseName?* .. rubric:: Parameters :FileBaseName: Not documented. Optional, default ``""``. .. index:: single: TestCase .. index:: single: osvvm namespace;TestCase .. _r-3a3aosvvm3a3aTestCase: TestCase ------------ .. parsed-literal:: **TestCase** *Name* .. rubric:: Parameters :Name: Not documented. .. index:: single: TestName .. index:: single: osvvm namespace;TestName .. _r-3a3aosvvm3a3aTestName: TestName ------------ .. parsed-literal:: **TestName** *Name* .. rubric:: Parameters :Name: Not documented. .. index:: single: TestSuite .. index:: single: osvvm namespace;TestSuite .. _r-3a3aosvvm3a3aTestSuite: TestSuite ------------- .. parsed-literal:: **TestSuite** *SuiteName* .. rubric:: Parameters :SuiteName: Not documented. .. index:: single: TimeIt .. index:: single: osvvm namespace;TimeIt .. _r-3a3aosvvm3a3aTimeIt: TimeIt ---------- .. parsed-literal:: **TimeIt** *?args?* .. rubric:: Parameters .. index:: single: UnsetLibraryVars .. index:: single: osvvm namespace;UnsetLibraryVars .. _r-3a3aosvvm3a3aUnsetLibraryVars: UnsetLibraryVars -------------------- .. parsed-literal:: **UnsetLibraryVars**