Changes between Version 23 and Version 24 of Java API

Timestamp:

12/04/12 12:58:47 (12 years ago)

Author:

jorisborgdorff

Comment:

--

Java API

@@ -236 +236 @@
 === Filters ===
 
-A conduit filter is like a mapper, but is only applied to a single conduit. The implementation is also more light-weight, and theoretically it is allowed to modify the timestamps of messages, or drop them all-together. To implement a filter, extend {{{muscle.core.conduit.filter.AbstractFilter}}}. This uses generics to indicate what values it should convert between. It is allowed to define a constructor, this should then either be empty or take a single {{{double}}} argument. The only function that should be overridden is apply() and this should call put() as many times as it wants to send a message. A simple multiplication-filter would look as follows
+A conduit filter is like a mapper, but it is only applied to a single conduit. The implementation is also more light-weight, and theoretically it is allowed to modify the timestamps of messages, or drop them all-together. To implement a filter, extend {{{muscle.core.conduit.filter.AbstractFilter}}}. This uses generics to indicate what values it should convert between. It is allowed to define a constructor which may take zero arguments or a single {{{double}}}. The only function that should be overridden is apply() and this should call put() as many times as it wants to send a message. A simple multiplication-filter would look as follows
 {{{
 public class MultiplicationFilter extends muscle.core.conduit.filter.AbstractFilter<double[], double[]> {
@@ -247 +247 @@
     @Override
     public void apply(Observation<double[]> obs) {
-        double[] data = obs.getData();
+        // Do not modify the original data of the submodel, so make a private copy and use the resulting data
+        double[] data = obs.privateCopy(SerializableDatatype.DOUBLE_ARR).getData();
 
         // perform multiplication
@@ -254 +255 @@
         }
 
-        // Create a new observable to send
+        // Create a new observation to send, with the same timestamps as the original
         Observation<double[]> multObs = obs.copyWithData(data);
         put(multObs);
@@ -261 +262 @@
 }}}
 
-In the {{{muscle.core.conduit.filter}}} are some examples of filters which are ready to use.
-
+In the {{{muscle.core.conduit.filter}}} are some examples of filters which are ready to use, they are explained in the [[Configuration|Configuration section]].
 === Terminals ===