Options
All
  • Public
  • Public/Protected
  • All
Menu

Holds all OutputModels of all AggregatorSubscriptions. A single AggregatorSubscription can hold multiple OutputModels, that are grouped in the OutputSubcollection.

Hierarchy

  • OutputCollection

Index

Constructors

constructor

Properties

Readonly id

id: string

Unique Id of this collection.

Private outputMap

outputMap: Map<string, OutputSubcollection>

Internal datastructure. Hashmap that is accesed via an AggregatorSubscriptions's unique Id.

Methods

add

  • Register a new output for a subscription.

    Parameters

    • aggSubValueId: string

      Unique Id of the subscription.

    • output: OutputModel

      The output model that is added to the subscription.

    Returns void

deleteOutput

  • deleteOutput(outputModelId: string): void
  • Delete an existing output of a subscription.

    Parameters

    • outputModelId: string

      The unique Id that is going to be deleted.

    Returns void

getOutputById

  • Retrieves an output.

    Parameters

    • id: string

      Unique Id of the output.

    Returns undefined | OutputModel

    An OutputModel if it exists, undefined otherwise.

getOutputListById

  • getOutputListById(id: string): undefined | OutputModel[]
  • Retrieves a list of all OutputModels a subscription has.

    Parameters

    • id: string

      Unique Id of an AggregatorSubscription.

    Returns undefined | OutputModel[]

update

  • Updates an existing output with new settings.

    Parameters

    • output: OutputModel

      Holds the new settings and unique Id of the output.

    Returns void

Static attributeTransformToClass

  • Workaround function to deserialize maps.

    Parameters

    • value: any

    Returns Map<string, OutputSubcollection>

Static attributeTransformToPlain

  • attributeTransformToPlain(value: any): object
  • Workaround to serialize maps.

    Parameters

    • value: any

    Returns object

Generated using TypeDoc