FilterDataInterface class

An interface carrying sample data and control into/out of filter modules.

Groups ports by FilterPortTag so that connectIO can wire inputs and outputs in a single call.

Inheritance

Constructors

FilterDataInterface({int dataWidth = 16})
Creates a FilterDataInterface with the given dataWidth (default 16 bits).

Properties

dataOut → Logic
Output filtered data bus.
no setter
hashCode → int
The hash code for this object.
no setterinherited
ports → Map<String, Logic>
Maps from the Interface's defined port name to an instance of a Logic.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sampleIn → Logic
Input sample data bus.
no setter
validIn → Logic
Input valid strobe.
no setter
validOut → Logic
Output valid strobe.
no setter

Methods

clone() → FilterDataInterface
Returns a new interface with the same data width.
override
conditionalDriveOther(Interface<FilterPortTag> other, Iterable<FilterPortTag> tags) → Conditional
Makes this conditionally drive interface signals tagged with tags on other.
inherited
conditionalReceiveOther(Interface<FilterPortTag> other, Iterable<FilterPortTag> tags) → Conditional
Makes this signals tagged with tags be driven conditionally by other.
inherited
connectIO(Module module, Interface srcInterface, {Iterable<FilterPortTag>? inputTags, Iterable<FilterPortTag>? outputTags, Iterable<FilterPortTag>? inOutTags, String uniquify(String original)?}) → void
Connects module's inputs, outputs, and inOuts up to srcInterface and this Interface.
inherited
driveOther(Interface<FilterPortTag> other, Iterable<FilterPortTag> tags) → void
Makes this drive interface signals tagged with tags on other.
inherited
getPorts([Iterable<FilterPortTag>? tags]) → Map<String, Logic>
Returns all interface ports associated with the provided tags as a Map from the port name to the Logic port.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
port(String name) → Logic
Accesses a port named name.
inherited
receiveOther(Interface<FilterPortTag> other, Iterable<FilterPortTag> tags) → void
Makes this signals tagged with tags be driven by other.
inherited
setPorts(List<Logic> ports, [Iterable<FilterPortTag>? tags]) → void
Adds a collection of ports to this Interface, each associated with all of tags.
inherited
toString() → String
A string representation of this object.
inherited
tryPort(String name) → Logic?
Provides the port named name if it exists, otherwise null.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited