Class IO`Abstract`

Base class for component IO.

Hierarchy (View Summary)

IO

Index

Constructors

Properties

Accessors

inputNames names outputNames

Methods

get signal connect connections disconnect

Constructors

constructor

new IO(): IO
Constructor.

Returns IO

Properties

component

component: null | Component

The component to which the IO is attached.

Accessors

inputNames

get inputNames(): readonly string[]
The names of all (Access.Writable) input signals belonging to the IO.

Returns readonly string[]

names

get names(): readonly string[]
The names of all signals belonging to the IO.

Returns readonly string[]

outputNames

get outputNames(): readonly string[]
The names of all (Access.Readable) output signals belonging to the IO.

Returns readonly string[]

Methods

get

get(name: string): null | Signal<SignalValueType>
Retrieves the signal with the specified name.
Parameters
- name: string
  The signal name.
Returns null | Signal<SignalValueType>
The found signal, or null if the signal was not found.

signal

signal(component: Component, name: string): null | Signal<SignalValueType>
Finds a signal belonging to the specified component's IO with the specified name.
Parameters
- component: Component
  The component.
- name: string
  The signal name.
Returns null | Signal<SignalValueType>
The found signal, or null if a signal with the specified name was not found.

`Static`connect

connect(
    world: World,
    first: Signal<SignalValueType>,
    second: Signal<SignalValueType>,
): boolean
Connects two signals together.
Parameters
- world: World
  The world.
- first: Signal<SignalValueType>
  The first signal.
- second: Signal<SignalValueType>
  The second signal.
Returns boolean
Whether the signals were successfully connected.

Remarks
One signal must be an input (Access.Writable) and the other must be an output (Access.Readable).

`Static`connections

connections(world: World, signal: Signal<SignalValueType>): IOConnectionReport[]
Retrieves the connections for a given signal.
Parameters
- world: World
  The world.
- signal: Signal<SignalValueType>
  The signal to report connections for.
Returns IOConnectionReport[]
The connection reports for the signal, or empty if the signal is not connected.

`Static`disconnect

disconnect(
    world: World,
    first: Signal<SignalValueType>,
    second: Signal<SignalValueType>,
): boolean
Disconnects two signals.
Parameters
- world: World
  The world.
- first: Signal<SignalValueType>
  The first signal.
- second: Signal<SignalValueType>
  The second signal.
Returns boolean
Whether the signals were successfully disconnected.

Remarks
One signal must be an input (Access.Writable) and the other must be an output (Access.Readable).