org.simantics.databoard.history
Class SamplingConfiguration

java.lang.Object
  extended by org.simantics.databoard.history.SamplingConfiguration

public class SamplingConfiguration
extends java.lang.Object

Sampling Configuration is a description how values are collected from a valuation source and written into a history container. SamplingConfiguration is an input file to SampleCollector. type SamplingConfiguration = { subscription : Subscription } type Subscription = { variableId : Variant, deadband : Optional( Double ), interval : Optional( Variant ) } See Sample Collector

Author:
Toni Kalajainen

Field Summary
 Subscription[] subscriptions
           
 MutableVariant timeId
           
 
Constructor Summary
SamplingConfiguration()
           
 
Method Summary
 void addSubscription(Variant nodeId, Variant interval, Variant deadband)
          Add a subscription to a node.
 void setTimeVariable(Variant timeId)
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

timeId

public MutableVariant timeId

subscriptions

public Subscription[] subscriptions
Constructor Detail

SamplingConfiguration

public SamplingConfiguration()
Method Detail

addSubscription

public void addSubscription(Variant nodeId,
                            Variant interval,
                            Variant deadband)
Add a subscription to a node.

Parameters:
nodeId - node id
interval - interval, optional
deadband - interval, optional

setTimeVariable

public void setTimeVariable(Variant timeId)