Class ConfigurableIO

Configurable component IO.

Remarks

Can be used to allow users to add/remove IO points at design time.

Hierarchy (View Summary)

IO
- ConfigurableIO
  - RobotControllerIO

Index

Constructors

Properties

Accessors

connections names

Methods

add configurable connect connection disconnect get inputConnection remove

Constructors

constructor

new ConfigurableIO(): ConfigurableIO
Constructor.

Returns ConfigurableIO
Overrides IO.constructor

Properties

component

component: null | Component

The component to which the IO is attached.

Accessors

connections

set connections(value: null | IOConnection[]): void
Parameters
- value: null | IOConnection[]
Returns void
Inherited from IO.connections

names

get names(): readonly string[]
The names of all signals.

Returns readonly string[]
Overrides IO.names

Methods

add

add(
    name: string,
    access: Access,
    type: DataType,
    value: SignalValueType,
): null | Signal<SignalValueType>
Attempts to add a signal.
Parameters
- name: string
  The unique name for the signal.
- access: Access
  The accessibility for the signal.
- type: DataType
  The data type for the signal.
- value: SignalValueType
  The initial value for the signal.
Returns null | Signal<SignalValueType>
The signal that was added, or null if the signal couldn't be added.
Remarks
Inputs are
See
- and outputs are
- .

configurable

configurable(name: string): boolean
Whether the signal with the specified name is configurable.
Parameters
- name: string
  The signal name.
Returns boolean
True if the signal is configurable, false otherwise.

connect

connect(
    inputName: string,
    outputName: string,
    outputComponent: null | Component,
): boolean
Connects the input belonging to this IO to an output of the specified component's IO.
Parameters
- inputName: string
  The name for the input.
- outputName: string
  The name for the output belonging to the specified component's IO.
- outputComponent: null | Component
  The component for the output.
Returns boolean
Whether the connection was successfully added.

Inherited from IO.connect

connection

connection(inputName: string): null | IOConnection
Finds the connection for the specified input, if one exists.
Parameters
- inputName: string
  The name for the input.
Returns null | IOConnection
The connection for the input, or null if a connection doesn't exist.

Inherited from IO.connection

disconnect

disconnect(inputName: string): boolean
Disconnects the input belonging to this IO.
Parameters
- inputName: string
  The name for the input.
Returns boolean
Whether the input was successfully disconnected.

Inherited from IO.disconnect

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.

Overrides IO.get

inputConnection

inputConnection(name: string): null | IOConnection
Parameters
- name: string
Returns null | IOConnection
Inherited from IO.inputConnection

remove

remove(name: string): boolean
Attempts to remove a signal.
Parameters
- name: string
  The name for the signal to be removed.
Returns boolean
True if the signal was removed, false otherwise.