Class

firrtl.transforms

GroupAnnotation

Related Doc: package transforms

Permalink

case class GroupAnnotation(components: Seq[ComponentName], newModule: String, newInstance: String, outputSuffix: Option[String] = None, inputSuffix: Option[String] = None) extends Annotation with Product with Serializable

Specifies a group of components, within a module, to pull out into their own module Components that are only connected to a group's components will also be included

components

components in this group

newModule

suggested name of the new module

newInstance

suggested name of the instance of the new module

outputSuffix

suggested suffix of any output ports of the new module

inputSuffix

suggested suffix of any input ports of the new module

Source
GroupComponents.scala
Linear Supertypes
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. GroupAnnotation
  2. Serializable
  3. Serializable
  4. Annotation
  5. Product
  6. Equals
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new GroupAnnotation(components: Seq[ComponentName], newModule: String, newInstance: String, outputSuffix: Option[String] = None, inputSuffix: Option[String] = None)

    Permalink

    components

    components in this group

    newModule

    suggested name of the new module

    newInstance

    suggested name of the instance of the new module

    outputSuffix

    suggested suffix of any output ports of the new module

    inputSuffix

    suggested suffix of any input ports of the new module

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. val components: Seq[ComponentName]

    Permalink

    components in this group

  7. def currentModule: String

    Permalink

    The module that all components are located in

  8. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  9. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  11. def getTargets: Seq[Target]

    Permalink

    Returns all Target members in this annotation

    Returns all Target members in this annotation

    Definition Classes
    Annotation
  12. val inputSuffix: Option[String]

    Permalink

    suggested suffix of any input ports of the new module

  13. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  14. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  15. val newInstance: String

    Permalink

    suggested name of the instance of the new module

  16. val newModule: String

    Permalink

    suggested name of the new module

  17. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  18. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  19. val outputSuffix: Option[String]

    Permalink

    suggested suffix of any output ports of the new module

  20. def serialize: String

    Permalink

    Optional pretty print

    Optional pretty print

    Definition Classes
    Annotation
    Note

    rarely used

  21. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  22. def update(renames: RenameMap): Seq[Annotation]

    Permalink

    Update the target based on how signals are renamed

    Update the target based on how signals are renamed

    Definition Classes
    GroupAnnotationAnnotation
  23. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  24. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Annotation

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped