InterfaceReference<InterfaceType extends PairInterface> class

A Reference to an interface on a BridgeModule.

This class provides access to a PairInterface that exists on the boundary of a BridgeModule. It manages the relationship between the external interface (visible from outside the module) and the optional internal interface (visible from inside the module), along with the port mappings between them.

Properties

hashCode → int
The hash code for this object.
no setteroverride
interface → InterfaceType
The external interface instance that exists "outside" of the module.
final
internalInterface → InterfaceType?
The internal interface instance that exists "inside" the module.
no setter
isFullyConnected → bool
Whether all interface ports are fully connected to module ports.
no setter
module → BridgeModule
The BridgeModule that this reference belongs to.
finalinherited
name → String
The name of this interface within the module.
final
portMaps → List<PortMap>
An unmodifiable list of all port mappings for this interface.
latefinal
ports → List<InterfacePortReference>
All port references that belong to this interface.
no setter
role → PairRole
The role that this interface plays in interface connections.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

addPortMap(InterfacePortReference interfacePort, PortReference port, {bool connect = true}) → PortMap
Creates a mapping between an interface port and a module port.
connectDownTo(InterfaceReference<PairInterface> other) → void
Establishes a hierarchical "downward" connection to a child interface.
connectTo(InterfaceReference<PairInterface> other, {Set<String> exceptPorts = const {}}) → void
Connects two interfaces at the same hierarchical level, sharing a parent.
connectUpTo(InterfaceReference<PairInterface> other) → void
Establishes a hierarchical "upward" connection to a parent interface.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
port(String portRef) → InterfacePortReference
Gets a reference to a specific port within this interface.
punchDownTo(BridgeModule subModule, {String? newIntfName, bool allowNameUniquification = false}) → InterfaceReference<PairInterface>
Creates a copy of this interface in a submodule.
punchUpTo(BridgeModule newModule, {String? newIntfName, bool allowNameUniquification = false, Set<String>? exceptPorts, String portUniquify(String logical)?}) → InterfaceReference<PairInterface>
Creates a copy of this interface in a parent module.
toString() → String
A string representation of this object.
override

Operators

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