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

t

firrtl.options

# Translator

###

#### trait Translator[A, B] extends TransformLike[A]

A TransformLike that internally translates the input type to some other type, transforms the internal type, and converts back to the original type.

This is intended to be used to insert a TransformLike parameterized by type `B` into a sequence of TransformLikes parameterized by type `A`.

A

  the type of the TransformLike

B

  the internal type

Source
  Phase.scala

Linear Supertypes
TransformLike[A], LazyLogging, AnyRef, Any
Type Hierarchy

Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. Translator
2. TransformLike
3. LazyLogging
4. AnyRef
5. 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

### Abstract Value Members

1.  implicit abstract def aToB(a: A): B

   A method converting type `A` into type `B`

   A method converting type `A` into type `B`

   returns

     an object of type `B`

   Attributes
     protected
2.  implicit abstract def bToA(b: B): A

   A method converting type `B` back into type `A`

   A method converting type `B` back into type `A`

   returns

     an object of type `A`

   Attributes
     protected
3.  abstract def internalTransform(b: B): B

   A transform on an internal type

   A transform on an internal type

   b

     an object of type `B`

   returns

     an object of type `B`

   Attributes
     protected
4.  abstract def name: String

   An identifier of this TransformLike that can be used for logging and informational printing

   An identifier of this TransformLike that can be used for logging and informational printing

   Definition Classes
     TransformLike

### Concrete 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 Translator[A, B] toany2stringadd[Translator[A, B]] performed by method any2stringadd in scala.Predef.
   Definition Classes
     any2stringadd
4.  def ->[B](y: B): (Translator[A, B], B)
   Implicit
     This member is added by an implicit conversion from Translator[A, B] toArrowAssoc[Translator[A, B]] performed by method ArrowAssoc in scala.Predef.
   Definition Classes
     ArrowAssoc
   Annotations
     @inline()
5.  final def ==(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
6.  final def asInstanceOf[T0]: T0
   Definition Classes
     Any
7.  def clone(): AnyRef
   Attributes
     protected[lang]
   Definition Classes
     AnyRef
   Annotations
     @throws(classOf[java.lang.CloneNotSupportedException]) @native()
8.  def ensuring(cond: (Translator[A, B]) => Boolean, msg: => Any): Translator[A, B]
   Implicit
     This member is added by an implicit conversion from Translator[A, B] toEnsuring[Translator[A, B]] performed by method Ensuring in scala.Predef.
   Definition Classes
     Ensuring
9.  def ensuring(cond: (Translator[A, B]) => Boolean): Translator[A, B]
   Implicit
     This member is added by an implicit conversion from Translator[A, B] toEnsuring[Translator[A, B]] performed by method Ensuring in scala.Predef.
   Definition Classes
     Ensuring
10.  def ensuring(cond: Boolean, msg: => Any): Translator[A, B]
    Implicit
      This member is added by an implicit conversion from Translator[A, B] toEnsuring[Translator[A, B]] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
11.  def ensuring(cond: Boolean): Translator[A, B]
    Implicit
      This member is added by an implicit conversion from Translator[A, B] toEnsuring[Translator[A, B]] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
12.  final def eq(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
13.  def equals(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef → Any
14.  def finalize(): Unit
    Attributes
      protected[lang]
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.Throwable])
15.  final def getClass(): Class[_ <: AnyRef]
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
16.  def getLogger: Logger
    Definition Classes
      LazyLogging
17.  def hashCode(): Int
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
18.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
19.  val logger: Logger
    Attributes
      protected
    Definition Classes
      LazyLogging
20.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
21.  final def notify(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
22.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
23.  final def synchronized[T0](arg0: => T0): T0
    Definition Classes
      AnyRef
24.  def toString(): String
    Definition Classes
      AnyRef → Any
25.  final def transform(a: A): A

    Convert the input object to the internal type, transform the internal type, and convert back to the original type

    Convert the input object to the internal type, transform the internal type, and convert back to the original type

    a

      an input object

    returns

      an output object of the same type

    Definition Classes
      Translator → TransformLike
26.  final def wait(): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException])
27.  final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException])
28.  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 Translator[A, B] toStringFormat[Translator[A, B]] 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): (Translator[A, B], B)
   Implicit
     This member is added by an implicit conversion from Translator[A, B] toArrowAssoc[Translator[A, B]] 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 TransformLike[A]

### Inherited from LazyLogging

### Inherited from AnyRef

### Inherited from Any

### Inherited by implicit conversion any2stringadd fromTranslator[A, B] to any2stringadd[Translator[A, B]]

### Inherited by implicit conversion StringFormat fromTranslator[A, B] to StringFormat[Translator[A, B]]

### Inherited by implicit conversion Ensuring fromTranslator[A, B] to Ensuring[Translator[A, B]]

### Inherited by implicit conversion ArrowAssoc fromTranslator[A, B] to ArrowAssoc[Translator[A, B]]

### Ungrouped