Package de.iip_ecosphere.platform.services.environment

Class DataMapper.BaseDataUnit

  • Enclosing class:
    DataMapper
    public abstract static class DataMapper.BaseDataUnit
extends java.lang.Object
    Base class to represent all potential inputs to the service and the JSON input format. Just defines the meta attributes (thus $ prefixes), needs to be refined with actual attributes by using class.
    Author:
    Holger Eichelberger, SSE

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private int $period  
      private int $repeats  

    • Constructor Summary

      Constructors 
      Constructor Description
      BaseDataUnit()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      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.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • $period

        private int $period

      • $repeats

        private int $repeats

    • Constructor Detail

      • BaseDataUnit

        public BaseDataUnit()

    • Method Detail

      • get$period

        public 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

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

      • set$period

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

      • set$repeats

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