Class/Object

spinal.lib.tools

ModuleAnalyzer

Related Docs: object ModuleAnalyzer | package tools

Permalink

class ModuleAnalyzer extends AnyRef

Module topology analyzer. It provides some methods that return the input or output pins, all sub-modules or sub-blackboxes, all clocks inside, and filter the returned results.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ModuleAnalyzer
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ModuleAnalyzer(module: Module)

    Permalink

    module

    the module being analyzed

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
    @HotSpotIntrinsicCandidate() @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  8. def getCells(cond: (Module) ⇒ Boolean): LinkedHashSet[Module]

    Permalink

    Get the submodule instances that meet the condition

    Get the submodule instances that meet the condition

    cond

    the condition that instance should meet.

    returns

    set of sub module instances

  9. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()
  10. def getClocks(filter: (ClockDomain) ⇒ Boolean): LinkedHashSet[ClockDomain]

    Permalink

    Get the clock domains matching the condition

    Get the clock domains matching the condition

    filter

    the predicate to filter the clock domains

    returns

    set of clock domain

  11. def getClocks: LinkedHashSet[ClockDomain]

    Permalink

    Get all the clock domains inside the module

    Get all the clock domains inside the module

    returns

    set of the clock domains

  12. def getInputs(filter: (BaseType) ⇒ Boolean): LinkedHashSet[BaseType]

    Permalink

    Get the input ports matching the condition

    Get the input ports matching the condition

    filter

    the predicate to filter the input ports

    returns

    set of filtered input ports

  13. def getInputs: LinkedHashSet[BaseType]

    Permalink

    Get all input ports of the module

    Get all input ports of the module

    returns

    set of base type

  14. def getLibCells(cond: (BlackBox) ⇒ Boolean): LinkedHashSet[BlackBox]

    Permalink

    Get the sub-blackbox instances that meet the condition

    Get the sub-blackbox instances that meet the condition

    cond

    the condition that instance should meet.

    returns

    set of sub blackbox instances

  15. def getLibPins(cond: (BaseType) ⇒ Boolean): LinkedHashSet[BaseType]

    Permalink

    Get pins of the sub-blackbox instance inside the module.

    Get pins of the sub-blackbox instance inside the module.

    cond

    the filtering condition

    returns

    set of the pin type

  16. def getNets(cond: (BaseType) ⇒ Boolean): LinkedHashSet[BaseType]

    Permalink

    Get the wire/net inside the module

    Get the wire/net inside the module

    cond

    the filtering condition

    returns

    set of the base type nets

  17. def getOutputs(filter: (BaseType) ⇒ Boolean): LinkedHashSet[BaseType]

    Permalink

    Get the output ports matching the condition

    Get the output ports matching the condition

    filter

    the predicate to filter the output ports

    returns

    set of filtered output ports

  18. def getOutputs: LinkedHashSet[BaseType]

    Permalink

    Get all output ports

    Get all output ports

    returns

    set of output base type

  19. def getPins(cond: (BaseType) ⇒ Boolean): LinkedHashSet[BaseType]

    Permalink

    Get pins of the sub-module instance inside the module.

    Get pins of the sub-module instance inside the module.

    cond

    the filtering condition

    returns

    set of the pin type

  20. def getPorts(cond: (BaseType) ⇒ Boolean): LinkedHashSet[BaseType]

    Permalink

    Get the toplevel module's ports

    Get the toplevel module's ports

    cond

    the filtering condition

    returns

    set of the ports

  21. def getRegisters(filter: (BaseType) ⇒ Boolean): LinkedHashSet[BaseType]

    Permalink

    Get the registers matching the condition

    Get the registers matching the condition

    filter

    the predicate to filter the registers

    returns

    set of filtered registers

  22. def getRegisters: LinkedHashSet[BaseType]

    Permalink

    Get all the registers inside the module

    Get all the registers inside the module

    returns

    set of register of base type

  23. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()
  24. final def isInstanceOf[T0]: Boolean

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

    Permalink
    Definition Classes
    AnyRef
  26. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  27. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  28. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  29. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  30. final def wait(arg0: Long, arg1: Int): Unit

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  32. final def wait(): Unit

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

Deprecated Value Members

  1. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from AnyRef

Inherited from Any

Ungrouped