FullyCombinational mixin Null safety
A Module which has only combinational logic within it and defines custom functionality.
This type of Module implies that any input port may combinationally affect any output.
Properties
- name → String
-
The name of this Module.
finalinherited
- reserveName → bool
-
If true, guarantees uniqueInstanceName matches name or else the
build will fail.
finalinherited
- reserveDefinitionName → bool
-
If true, guarantees definitionName is maintained by a Synthesizer,
or else it will fail.
finalinherited
- parent → Module?
-
The parent Module of this Module.
read-onlyinherited
-
inputs
→ Map<
String, Logic> -
A map from input port names to this Module to corresponding
Logic
signals.read-onlyinherited -
outputs
→ Map<
String, Logic> -
A map from output port names to this Module to corresponding
Logic
signals.read-onlyinherited -
subModules
→ Iterable<
Module> -
An Iterable of all
Module
s contained within thisModule
.read-onlyinherited -
internalSignals
→ Iterable<
Logic> -
An Iterable of all
Logic
s contained within this Module which are not an input or output port of this Module.read-onlyinherited -
signals
→ Iterable<
Logic> -
An Iterable of all
Logic
s contained within this Module, including inputs, outputs, and internal signals of this Module.read-onlyinherited - uniqueInstanceName → String
-
If this module has a parent, after build this will be a guaranteed
unique name within its scope.
read-onlyinherited
- definitionName → String
-
The definition name of this Module used when instantiating instances in
generated code.
read-onlyinherited
- hasBuilt → bool
-
Indicates whether this Module has had the build() method called on it.
read-onlyinherited
-
combinationalPaths
→ Map<
Logic, List< Logic> > -
A mapping of purely combinational paths from each input port to all
downstream output ports.
read-onlyinherited
-
reverseCombinationalPaths
→ Map<
Logic, List< Logic> > -
The opposite of combinationalPaths, where every key of the Map is an
output and the values are lists of inputs which could combinationally
affect that output.
read-onlyinherited
- hashCode → int
-
The hash code for this object.
read-onlyinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
read-onlyinherited
Methods
-
addInput(
String name, Logic x, {int width = 1}) → Logic -
Registers a signal as an input to this Module and returns an input port
that can be consumed.
inherited
-
addOutput(
String name, {int width = 1}) → Logic -
Registers an output to this Module and returns an output port that
can be driven.
inherited
-
build(
) → Future< void> -
Builds the Module and all subModules within it.
inherited
-
generateSynth(
) → String -
Returns a synthesized version of this Module.
inherited
-
getCombinationalPaths(
) → Map< Logic, List< Logic> > -
Returns a mapping of purely combinational paths from each input port
to all downstream output ports.
override
-
hierarchy(
) → Iterable< Module> -
Returns an Iterable of
Module
s representing the hierarchical path to thisModule
.inherited -
hierarchyString(
[int indent = 0]) → String -
Returns a pretty-print String of the heirarchy of all Modules within
this Module.
inherited
-
input(
String name) → Logic -
Accesses the Logic associated with this Modules input port
named
name
.inherited -
isInput(
Logic net) → bool -
Returns true iff
net
is the same Logic as the input port of this Module with the same name.inherited -
isOutput(
Logic net) → bool -
Returns true iff
net
is the same Logic as the output port of this Module with the same name.inherited -
isPort(
Logic net) → bool -
Returns true iff
net
is the same Logic as an input or output port of this Module with the same name.inherited -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a non-existent method or property is accessed.
inherited
-
output(
String name) → Logic -
Accesses the Logic associated with this Modules output port
named
name
.inherited -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited