Class DataMapper.BaseDataUnit
java.lang.Object
de.iip_ecosphere.platform.services.environment.DataMapper.BaseDataUnit
- All Implemented Interfaces:
DataMapper.BaseDataUnitFunctions
- Enclosing class:
DataMapper
public abstract static class DataMapper.BaseDataUnit
extends Object
implements DataMapper.BaseDataUnitFunctions
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 -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionintReturns the delay period between this and the next data unit.intReturns the number of repeats of this data unit.voidset$period(int $period) Changes the delay period between this and the next data unit.voidset$repeats(int $repeats) Changes the number of repeats of this data unit.
-
Field Details
-
$period
private int $period -
$repeats
private int $repeats
-
-
Constructor Details
-
BaseDataUnit
public BaseDataUnit()
-
-
Method Details
-
get$period
public int get$period()Description copied from interface:DataMapper.BaseDataUnitFunctionsReturns the delay period between this and the next data unit.- Specified by:
get$periodin interfaceDataMapper.BaseDataUnitFunctions- Returns:
- the period in ms, use default/last value if zero or negative
-
get$repeats
public int get$repeats()Description copied from interface:DataMapper.BaseDataUnitFunctionsReturns the number of repeats of this data unit.- Specified by:
get$repeatsin interfaceDataMapper.BaseDataUnitFunctions- Returns:
- the number of repeats, negative for infinite
-
set$period
public void set$period(int $period) Description copied from interface:DataMapper.BaseDataUnitFunctionsChanges the delay period between this and the next data unit. [snakeyaml]- Specified by:
set$periodin interfaceDataMapper.BaseDataUnitFunctions- Parameters:
$period- the period in ms, default/last value if zero or negative
-
set$repeats
public void set$repeats(int $repeats) Description copied from interface:DataMapper.BaseDataUnitFunctionsChanges the number of repeats of this data unit. [snakeyaml]- Specified by:
set$repeatsin interfaceDataMapper.BaseDataUnitFunctions- Parameters:
$repeats- the number of repeats, negative for infinite
-