chisel6.4.0 < Back


# Packages

-  package root
  Definition Classes
    root
-  package firrtl
  Definition Classes
    root
-  package options
  Definition Classes
    firrtl
-  package internal
  Definition Classes
    options
-  package phases
  Definition Classes
    options
- BareShell
- BufferedCustomFileEmission
- CustomFileEmission
- Dependency
- DependencyAPI
- DependencyManager
- DependencyManagerException
- DependencyManagerUtils
- DoNotTerminateOnExit
- DuplicateHandling
- ExceptOnError
- ExitCode
- ExitFailure
- ExitSuccess
- GeneralError
- HasShellOptions
- IdentityLike
- InputAnnotationFileAnnotation
- OptionsException
- OptionsHelpException
- OptionsView
- OutputAnnotationFileAnnotation
- Phase
- PhaseException
- PhaseManager
- PhasePrerequisiteException
- ProgramArgsAnnotation
- RegisteredLibrary
- Shell
- ShellOption
- Stage
- StageError
- StageMain
- StageOption
- StageOptions
- StageOptionsView
- StageUtils
- TargetDirAnnotation
- TransformLike
- Translator
- Unserializable
- Viewer

c

firrtl.options

# StageOptions

###

#### class StageOptions extends AnyRef

Options that every stage shares

Source
  StageOptions.scala

Linear Supertypes
AnyRef, Any
Type Hierarchy

Ordering

1. Alphabetic
2. By Inheritance

Inherited

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

### 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 StageOptions toany2stringadd[StageOptions] performed by method any2stringadd in scala.Predef.
   Definition Classes
     any2stringadd
4.  def ->[B](y: B): (StageOptions, B)
   Implicit
     This member is added by an implicit conversion from StageOptions toArrowAssoc[StageOptions] performed by method ArrowAssoc in scala.Predef.
   Definition Classes
     ArrowAssoc
   Annotations
     @inline()
5.  final def ==(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
6.  val annotationFileOut: Option[String]
7.  val annotationFilesIn: Seq[String]
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 ensuring(cond: (StageOptions) => Boolean, msg: => Any): StageOptions
    Implicit
      This member is added by an implicit conversion from StageOptions toEnsuring[StageOptions] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
11.  def ensuring(cond: (StageOptions) => Boolean): StageOptions
    Implicit
      This member is added by an implicit conversion from StageOptions toEnsuring[StageOptions] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
12.  def ensuring(cond: Boolean, msg: => Any): StageOptions
    Implicit
      This member is added by an implicit conversion from StageOptions toEnsuring[StageOptions] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
13.  def ensuring(cond: Boolean): StageOptions
    Implicit
      This member is added by an implicit conversion from StageOptions toEnsuring[StageOptions] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
14.  final def eq(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
15.  def equals(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef → Any
16.  def finalize(): Unit
    Attributes
      protected[lang]
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.Throwable])
17.  def getBuildFileName(filename: String, suffix: Option[String] = None): String

    Generate a filename (with an optional suffix) and create any parent directories.

    Generate a filename (with an optional suffix) and create any parent directories. Suffix is only added if it is not already there.

    filename

      the name of the file

    suffix

      an optional suffix that the file must end in

    returns

      the name of the file

    Note

      the filename may include a path

18.  final def getClass(): Class[_ <: AnyRef]
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
19.  def hashCode(): Int
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
20.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
21.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
22.  final def notify(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
23.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
24.  val programArgs: Seq[String]
25.  final def synchronized[T0](arg0: => T0): T0
    Definition Classes
      AnyRef
26.  val targetDir: String
27.  def toString(): String
    Definition Classes
      AnyRef → Any
28.  final def wait(): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException])
29.  final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException])
30.  final def wait(arg0: Long): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException]) @native()

### Deprecated Value Members

1.  def formatted(fmtstr: String): String
   Implicit
     This member is added by an implicit conversion from StageOptions toStringFormat[StageOptions] 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): (StageOptions, B)
   Implicit
     This member is added by an implicit conversion from StageOptions toArrowAssoc[StageOptions] 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 fromStageOptions to any2stringadd[StageOptions]

### Inherited by implicit conversion StringFormat fromStageOptions to StringFormat[StageOptions]

### Inherited by implicit conversion Ensuring fromStageOptions to Ensuring[StageOptions]

### Inherited by implicit conversion ArrowAssoc fromStageOptions to ArrowAssoc[StageOptions]

### Ungrouped