Class OutputSubcollection

Holds all OutputModels of a single AggregatorSubscriptions.

Hierarchy

OutputSubcollection

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new OutputSubcollection(): OutputSubcollection

- Defined in shared/outputCollection.class.ts:54
Returns OutputSubcollection

Properties

Readonly id

id: string

Unique Id.

Private outputList

outputList: OutputModel[]

Internal datastructure for all Output Models.

Accessors

length

get length(): number

- Defined in shared/outputCollection.class.ts:123
Returns the number of outputs that live in this subcollection, i.e. the number of all outputs an AggregatorSubscription has.

Returns number

outputs

get outputs(): OutputModel[]

- Defined in shared/outputCollection.class.ts:68
Returns a list of all outputs of this subcollection.

Returns OutputModel[]

Methods

add

add(output: OutputModel): void

- Defined in shared/outputCollection.class.ts:63
Adds an OutputModel to the end of this subcollection.

Parameters
- output: OutputModel
  
  The OutputModel to be added.
Returns void

delete

delete(outputId: string): void

- Defined in shared/outputCollection.class.ts:100
Removes an output from this subcollection.

Parameters
- outputId: string
  
  Unique Id of the output.
Returns void

getById

getById(outputId: string): undefined | OutputModel

- Defined in shared/outputCollection.class.ts:77
Returns the output.

Parameters
- outputId: string
  
  Unique Id of the output.
Returns undefined | OutputModel
An OutputModel given it exists, undefined otherwise.

has

has(outputId: string): boolean

- Defined in shared/outputCollection.class.ts:89
Checks if an OutputModel lives in this subcollection.

Parameters
- outputId: string
  
  Unique Id of the output.
Returns boolean
True if it exists, false otherwise.

update

update(output: OutputModel): void

- Defined in shared/outputCollection.class.ts:113
Updates an output with new settings.

Parameters
- output: OutputModel
  
  An output that holds the new settings.
Returns void

Generated using TypeDoc