chisel6.4.0 < Back


# Packages

-  package root
  Definition Classes
    root
-  package chisel3

  This package contains the main chisel3 API.

  This package contains the main chisel3 API.

  Definition Classes
    root
-  package interface
  Definition Classes
    chisel3
-  trait Interface extends InterfaceCommon

  An interface between hardware units.

  An interface between hardware units. Any module that implements this interface may be separately compiled from any module that instantiates this interface.

  Definition Classes
    interface
- Entity
- Wrapper

t

chisel3.interface.Interface

# Entity

###

#### sealed trait Entity extends AnyRef

Self Type
  (Interface.this)#Entity with BaseModule
Source
  Interface.scala

Linear Supertypes
AnyRef, Any
Known Subclasses
BlackBox, Module, Stub
Type Hierarchy

Ordering

1. Alphabetic
2. By Inheritance

Inherited

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

### Abstract Value Members

1.  abstract val io: (Interface.this)#Ports
2.  abstract def properties[B <: BaseModule](implicit arg0: (Interface.this)#Conformance[B]): (Interface.this)#Properties

   Return the properties of this instance.

### 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 (Interface.this)#Entity toany2stringadd[(Interface.this)#Entity] performed by method any2stringadd in scala.Predef.
   Definition Classes
     any2stringadd
4.  def ->[B](y: B): ((Interface.this)#Entity, B)
   Implicit
     This member is added by an implicit conversion from (Interface.this)#Entity toArrowAssoc[(Interface.this)#Entity] 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.  final def desiredName: String
9.  def ensuring(cond: ((Interface.this)#Entity) => Boolean, msg: => Any): (Interface.this)#Entity
   Implicit
     This member is added by an implicit conversion from (Interface.this)#Entity toEnsuring[(Interface.this)#Entity] performed by method Ensuring in scala.Predef.
   Definition Classes
     Ensuring
10.  def ensuring(cond: ((Interface.this)#Entity) => Boolean): (Interface.this)#Entity
    Implicit
      This member is added by an implicit conversion from (Interface.this)#Entity toEnsuring[(Interface.this)#Entity] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
11.  def ensuring(cond: Boolean, msg: => Any): (Interface.this)#Entity
    Implicit
      This member is added by an implicit conversion from (Interface.this)#Entity toEnsuring[(Interface.this)#Entity] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
12.  def ensuring(cond: Boolean): (Interface.this)#Entity
    Implicit
      This member is added by an implicit conversion from (Interface.this)#Entity toEnsuring[(Interface.this)#Entity] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
13.  final def eq(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
14.  def equals(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef → Any
15.  def finalize(): Unit
    Attributes
      protected[lang]
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.Throwable])
16.  final def getClass(): Class[_ <: AnyRef]
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
17.  def hashCode(): Int
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
18.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
19.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
20.  final def notify(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
21.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
22.  final def synchronized[T0](arg0: => T0): T0
    Definition Classes
      AnyRef
23.  def toString(): String
    Definition Classes
      AnyRef → Any
24.  final def wait(): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException])
25.  final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException])
26.  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 (Interface.this)#Entity toStringFormat[(Interface.this)#Entity] 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): ((Interface.this)#Entity, B)
   Implicit
     This member is added by an implicit conversion from (Interface.this)#Entity toArrowAssoc[(Interface.this)#Entity] 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 from(Interface.this)#Entity to any2stringadd[(Interface.this)#Entity]

### Inherited by implicit conversion StringFormat from(Interface.this)#Entity to StringFormat[(Interface.this)#Entity]

### Inherited by implicit conversion Ensuring from(Interface.this)#Entity to Ensuring[(Interface.this)#Entity]

### Inherited by implicit conversion ArrowAssoc from(Interface.this)#Entity to ArrowAssoc[(Interface.this)#Entity]

### Ungrouped