Package de.iip_ecosphere.platform.services.environment

Interface DataMapper.BaseDataUnitFunctions

All Known Implementing Classes:
DataMapper.BaseDataUnit
Enclosing class:
DataMapper
public static interface DataMapper.BaseDataUnitFunctions
Interface to represent all potential inputs to the service and the JSON input format. Defines the meta attributes (thus $ prefixes), needs to be refined with actual attributes by using class. Can be used for dynamic class proxying.
Author:
Holger Eichelberger, SSE

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    get$period()
    Returns the delay period between this and the next data unit.
    int
    get$repeats()
    Returns the number of repeats of this data unit.
    void
    set$period(int $period)
    Changes the delay period between this and the next data unit.
    void
    set$repeats(int $repeats)
    Changes the number of repeats of this data unit.

  • Method Details

    • get$period

      int get$period()
      Returns the delay period between this and the next data unit.
      Returns:
      the period in ms, use default/last value if zero or negative

    • get$repeats

      int get$repeats()
      Returns the number of repeats of this data unit.
      Returns:
      the number of repeats, negative for infinite

    • set$period

      void set$period(int $period)
      Changes the delay period between this and the next data unit. [snakeyaml]
      Parameters:
      $period - the period in ms, default/last value if zero or negative

    • set$repeats

      void set$repeats(int $repeats)
      Changes the number of repeats of this data unit. [snakeyaml]
      Parameters:
      $repeats - the number of repeats, negative for infinite