Averager plugin: possibility to enable/disable by property and events

ARE/components/processor.averager/src/main/java/eu/asterics/component/processor/averager/AveragerInstance.java

@@ -28,12 +28,10 @@
 
 import java.util.LinkedList;
 
+import eu.asterics.mw.model.runtime.*;
 import org.apache.commons.math3.stat.StatUtils;
 
 import eu.asterics.mw.data.ConversionUtils;
-import eu.asterics.mw.model.runtime.AbstractRuntimeComponentInstance;
-import eu.asterics.mw.model.runtime.IRuntimeInputPort;
-import eu.asterics.mw.model.runtime.IRuntimeOutputPort;
 import eu.asterics.mw.model.runtime.impl.DefaultRuntimeInputPort;
 import eu.asterics.mw.model.runtime.impl.DefaultRuntimeOutputPort;
 
@@ -57,13 +55,15 @@ public class AveragerInstance extends AbstractRuntimeComponentInstance {
     private IRuntimeOutputPort opOutput = new OutputPort1();
 
     private int propBufferSize = DEFAULT_BUFFER_SIZE;
+    private boolean propEnabled = true;
     private int propMode = 0;
+    private int propAutoReenableTime = 0;
 
     private final LinkedList<Double> buffer = new LinkedList<Double>();
     private long lastUpdate = 0;
     private double accu = 0;
-
     private double sum = 0;
+    private long disableTime = 0;
 
     /**
      * The class constructor.
@@ -104,6 +104,37 @@ public IRuntimeOutputPort getOutputPort(String portID) {
         }
     }
 
+    /**
+     * returns an Event Listener Port.
+     *
+     * @param eventPortID
+     *            the name of the port
+     * @return the EventListener port or null if not found
+     */
+    public IRuntimeEventListenerPort getEventListenerPort(String eventPortID) {
+        if ("enablePlugin".equalsIgnoreCase(eventPortID)) {
+            return elpEnablePlugin;
+        }
+        if ("disablePlugin".equalsIgnoreCase(eventPortID)) {
+            return elpDisablePlugin;
+        }
+
+        return null;
+    }
+
+    private final IRuntimeEventListenerPort elpEnablePlugin = new IRuntimeEventListenerPort() {
+        public void receiveEvent(final String data) {
+            propEnabled = true;
+        }
+    };
+
+    private final IRuntimeEventListenerPort elpDisablePlugin = new IRuntimeEventListenerPort() {
+        public void receiveEvent(final String data) {
+            propEnabled = false;
+            disableTime = System.currentTimeMillis();
+        }
+    };
+
     /**
      * returns the value of the given property.
      * 
@@ -113,10 +144,14 @@ public IRuntimeOutputPort getOutputPort(String portID) {
      */
     @Override
     public Object getRuntimePropertyValue(String propertyName) {
-        if ("bufferSize".equalsIgnoreCase(propertyName)) {
+        if ("enabled".equalsIgnoreCase(propertyName)) {
+            return propEnabled;
+        } else if ("bufferSize".equalsIgnoreCase(propertyName)) {
             return propBufferSize;
         } else if ("mode".equalsIgnoreCase(propertyName)) {
             return propMode;
+        } else if ("autoReenableTime".equalsIgnoreCase(propertyName)) {
+            return propAutoReenableTime;
         } else {
             return null;
         }
@@ -132,7 +167,11 @@ public Object getRuntimePropertyValue(String propertyName) {
      */
     @Override
     public synchronized Object setRuntimePropertyValue(String propertyName, Object newValue) {
-        if ("bufferSize".equalsIgnoreCase(propertyName)) {
+        if ("enabled".equalsIgnoreCase(propertyName)) {
+            final Object oldValue = propEnabled;
+            propEnabled = Boolean.parseBoolean((String) newValue);
+            return oldValue;
+        } else if ("bufferSize".equalsIgnoreCase(propertyName)) {
             final Object oldValue = propBufferSize;
 
             if (newValue != null) {
@@ -165,6 +204,10 @@ public synchronized Object setRuntimePropertyValue(String propertyName, Object n
                 }
             }
             return oldValue;
+        }  else if ("autoReenableTime".equalsIgnoreCase(propertyName)) {
+            final Object oldValue = propAutoReenableTime;
+            propAutoReenableTime = Integer.parseInt(newValue.toString());
+            return oldValue;
         } else {
             return null;
         }
@@ -177,6 +220,12 @@ public synchronized Object setRuntimePropertyValue(String propertyName, Object n
      * samples are summed but not divided
      */
     private synchronized void process(final double in) {
+        if (!propEnabled) {
+            if (System.currentTimeMillis() - disableTime < propAutoReenableTime || propAutoReenableTime == 0) {
+                return;
+            }
+            propEnabled = true;
+        }
         if (propMode == MODE_AVERAGE) {
             buffer.addFirst(in);
             sum += in;

ARE/components/processor.averager/src/main/resources/bundle_descriptor.xml

@@ -18,7 +18,19 @@
                 <dataType>double</dataType>
             </outputPort>
         </ports>
-        <properties>
+    <events>
+        <eventListenerPort id="enablePlugin">
+            <description>enables the functionality of this plugin</description>
+        </eventListenerPort>
+        <eventListenerPort id="disablePlugin">
+            <description>disables the functionality of this plugin</description>
+        </eventListenerPort>
+    </events>
+    <properties>
+            <property name="enabled"
+                      type="boolean"
+                      value="true"
+                      description="if true, the plugin is enabled, if false the plugin does nothing"/>
             <property name="bufferSize"
                       type="integer"
                       value="50"
@@ -28,6 +40,10 @@
                       value="0"
                       combobox="average//averager with integer output//accumulate for n milliseconds//median"
                       description="The averager or accumulator mode"/>
+            <property name="autoReenableTime"
+                      type="integer"
+                      value="0"
+                      description="time in ms, after the plugin automatically re-enables itself after being disabled. Set to zero to deactivate this functionality (never auto re-enable)."/>
         </properties>
     </componentType>
 

Documentation/ACS-Help/HTML/Plugins/processors/Averager.htm

@@ -20,8 +20,18 @@ <H2>Output Port Description</H2>
 		<ul>
 			<li><STRONG>output [double]:</STRONG> This port provides the current average of the buffered inputs.</li>
 		</ul>
+		<H2>Event Listener Description</H2>
+		<ul>
+			<li><STRONG>enablePlugin:</STRONG> Enables the functionality of this plugin. </li>
+			<li>
+				<STRONG>disablePlugin:</STRONG> Disables the functionality of this plugin. New values aren't accumulated anymore and no output is sent to the output port.
+				If property autoReenableTime set, the plugin is automatically re-enabled after the time defined by this property.
+				Generally disabling is delayed until the buffer of values is full, preventing any startup glitches.
+			</li>
+		</ul>
 		<H2>Properties</H2>
 		<ul>
+			<li><STRONG>enabled [boolean]:</STRONG> if true (default), the plugin is enabled, if false the plugin does nothing. Generally disabling is delayed until the buffer of values is full, preventing any startup glitches.</li>
 			<li>
 				<STRONG>mode [integer]:</STRONG> Denotes the operating mode of the unit, three modes are available:
 				<ul>
@@ -31,6 +41,7 @@ <H2>Properties</H2>
 				</ul>
 			</li>
 			<li><STRONG>bufferSize [integer]:</STRONG> Specifies the size of the buffer in the averaging modes or the amount of milliseconds to accumulate in the accumulator mode.</li>
+			<li><STRONG>autoReenableTime [integer]:</STRONG> Time in ms, after the plugin automatically re-enables itself after being disabled. Set to zero (default) to deactivate this functionality (never auto re-enable).</li>
 		</ul>
 	</BODY>
 </HTML>