chisel6.4.0 < Back


# Packages

-  package root
  Definition Classes
    root
-  package svsim
  Definition Classes
    root
-  package vcs
  Definition Classes
    svsim
-  package verilator
  Definition Classes
    svsim
- Backend
- CommonCompilationSettings
- ModuleInfo
- Simulation
- Workspace

c

svsim

# Workspace

###
Companion object Workspace

#### final class Workspace extends AnyRef

Source
  Workspace.scala

Linear Supertypes
AnyRef, Any
Type Hierarchy

Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. Workspace
2. AnyRef
3. Any

Implicitly

1. by any2stringadd
2. by StringFormat
3. by Ensuring
4. by ArrowAssoc

1. Hide All
2. Show All

Visibility

1. Public
2. Protected

### Instance Constructors

1.  new Workspace(path: String, workingDirectoryPrefix: String = "workdir")

### Value Members

1.  final def !=(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
2.  final def ##: Int
   Definition Classes
     AnyRef → Any
3.  def +(other: String): String
   Implicit
     This member is added by an implicit conversion from Workspace toany2stringadd[Workspace] performed by method any2stringadd in scala.Predef.
   Definition Classes
     any2stringadd
4.  def ->[B](y: B): (Workspace, B)
   Implicit
     This member is added by an implicit conversion from Workspace toArrowAssoc[Workspace] performed by method ArrowAssoc in scala.Predef.
   Definition Classes
     ArrowAssoc
   Annotations
     @inline()
5.  final def ==(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
6.  val absolutePath: String
7.  def addPrimarySourceFromResource(klass: Class[_], name: String): Unit

   A helper method which copies the specified resource into the primary sources directory.

8.  final def asInstanceOf[T0]: T0
   Definition Classes
     Any
9.  def clone(): AnyRef
   Attributes
     protected[lang]
   Definition Classes
     AnyRef
   Annotations
     @throws(classOf[java.lang.CloneNotSupportedException]) @native()
10.  def compile[T <: Backend](backend: T)(workingDirectoryTag: String, commonSettings: CommonCompilationSettings, backendSpecificSettings: compile.T.CompilationSettings, customSimulationWorkingDirectory: Option[String], verbose: Boolean): Simulation

    Compiles the simulation using the specified backend.

11.  def elaborate(moduleInfo: ModuleInfo): Unit

    `svsim` elaboration simply stores the provided `ModuleInfo` for use by the `compile` method.

    `svsim` elaboration simply stores the provided `ModuleInfo` for use by the `compile` method. The idea is that packages that actually do elaboration (like Chisel) will add an overload of this method in an implicit class that then calls this method with the appropriate `ModuleInfo`.

12.  def ensuring(cond: (Workspace) => Boolean, msg: => Any): Workspace
    Implicit
      This member is added by an implicit conversion from Workspace toEnsuring[Workspace] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
13.  def ensuring(cond: (Workspace) => Boolean): Workspace
    Implicit
      This member is added by an implicit conversion from Workspace toEnsuring[Workspace] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
14.  def ensuring(cond: Boolean, msg: => Any): Workspace
    Implicit
      This member is added by an implicit conversion from Workspace toEnsuring[Workspace] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
15.  def ensuring(cond: Boolean): Workspace
    Implicit
      This member is added by an implicit conversion from Workspace toEnsuring[Workspace] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
16.  final def eq(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
17.  def equals(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef → Any
18.  def finalize(): Unit
    Attributes
      protected[lang]
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.Throwable])
19.  final def generateAdditionalSources(): Unit

    Generate additional sources necessary for simulating the module.

20.  val generatedSourcesPath: String

    The directory containing code generated when calling `generateAdditionalSources`

21.  final def getClass(): Class[_ <: AnyRef]
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
22.  def hashCode(): Int
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
23.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
24.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
25.  final def notify(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
26.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
27.  val primarySourcesPath: String

    The directory containing user-provided source files used to compile the simulation when `compile` is called.

28.  def reset(): Unit
29.  val supportArtifactsPath: String

    A directory where the user can store additional artifacts which are relevant to the primary sources (for instance, artifacts related to the generation of primary sources).

    A directory where the user can store additional artifacts which are relevant to the primary sources (for instance, artifacts related to the generation of primary sources). These artifacts have no impact on the simulation, but it may be useful to group them with the other files generated by svsim for debugging purposes.

30.  final def synchronized[T0](arg0: => T0): T0
    Definition Classes
      AnyRef
31.  def toString(): String
    Definition Classes
      AnyRef → Any
32.  final def wait(): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException])
33.  final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException])
34.  final def wait(arg0: Long): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException]) @native()
35.  val workingDirectoryPrefix: String

### Deprecated Value Members

1.  def formatted(fmtstr: String): String
   Implicit
     This member is added by an implicit conversion from Workspace toStringFormat[Workspace] performed by method StringFormat in scala.Predef.
   Definition Classes
     StringFormat
   Annotations
     @deprecated @inline()
   Deprecated

     (Since version 2.12.16) Use `formatString.format(value)` instead of `value.formatted(formatString)`, or use the `f""` string interpolator. In Java 15 and later, `formatted` resolves to the new method in String which has reversed parameters.

2.  def →[B](y: B): (Workspace, B)
   Implicit
     This member is added by an implicit conversion from Workspace toArrowAssoc[Workspace] performed by method ArrowAssoc in scala.Predef.
   Definition Classes
     ArrowAssoc
   Annotations
     @deprecated
   Deprecated

     (Since version 2.13.0) Use `->` instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

### Inherited from AnyRef

### Inherited from Any

### Inherited by implicit conversion any2stringadd fromWorkspace to any2stringadd[Workspace]

### Inherited by implicit conversion StringFormat fromWorkspace to StringFormat[Workspace]

### Inherited by implicit conversion Ensuring fromWorkspace to Ensuring[Workspace]

### Inherited by implicit conversion ArrowAssoc fromWorkspace to ArrowAssoc[Workspace]

### Ungrouped