Changes between Version 13 and Version 14 of Configuration

Timestamp:

12/03/12 16:45:46 (12 years ago)

Author:

jorisborgdorff

Comment:

--

Configuration

@@ -63 +63 @@
 ||{{{pipe}}}                ||{{{PipeFilter}}}                      ||none                ||any                 ||Forwards all incoming messages unchanged||
 ||{{{console}}}             ||{{{ConsoleWriterFilter}}}             ||none                ||any                 ||Prints all messages to console and forwards them||
+||{{{thread}}}             ||{{{ThreadedFilter}}}             ||none                ||any                 ||Runs a thread, so the following filter will run in a separate thread||
+||{{{serialize}}}             ||{{{SerializeFilter}}}             ||none                ||any to {{{byte[]}}}                 ||Serializes any serializable Java object to a byte array||
+||{{{deserialize}}}             ||{{{DeserializeFilter}}}             ||none                ||{{{byte[]}}} to object      ||Deserializes a serialized byte array to a Java object||
+||{{{compress}}}             ||{{{CompressFilter}}}             ||none                ||{{{byte[]}}}                 ||Compresses byte arrays using the Deflate algorithm||
+||{{{decompress}}}             ||{{{DecompressFilter}}}             ||none                ||{{{byte[]}}}                 ||Decompresses compressed byte arrays||
+||{{{chunk}}}             ||{{{ChunkFilter}}}             ||{{{int chunks}}}                ||{{{byte[]}}}                ||Splits up a byte array into {{{chunks}}} smaller byte arrays for separate processing.||
+||{{{dechunk}}}             ||{{{DechunkFilter}}}             ||{{{int chunks}}}                ||{{{byte[]}}}                ||Combines a byte array that was split up by the chunk filter.||
 ||{{{linearinterpolation}}} ||{{{LinearInterpolationFilterDouble}}} ||none                ||{{{double[]}}}      ||Creates a {{{double[]}}} of length-1 of the original, and linearly interpolates between the original values: {{{k'_i <- (k_i+k_{i+1})/2}}}||
 ||{{{multiply}}}            ||{{{MultiplyFilterDouble}}}            ||{{{double factor}}} ||{{{double[]}}}      ||Multiplies each value of the incoming message by {{{factor}}}||
@@ -75 +82 @@
 cs.attach('w' => 'r') {
         tie('dataOut', 'dataIn',['multiply_0.5','console'])
+}
+}}}
+
+By default, the conduit filters get applied at the receiving submodel. If a filter should be applied at the sending submodel, or if filters should be applied at both locations, the tie argument can take an additional argument, so that the first list of filters is applied at the sending side and the second list of filters is applied at the receiving side.
+The following fragment multiplies the data with a constant on the sending side, and prints it on the receiving side:
+{{{
+cs.attach('w' => 'r') {
+        tie('dataOut', 'dataIn',['multiply_0.5'],['console'])
+}
+}}}
+
+And the following fragment compresses data on the sending side and uncompresses it on the receiving side:
+{{{
+cs.attach('w' => 'r') {
+        tie('dataOut', 'dataIn',['serialize','compress'],['decompress','deserialize'])
+}
+}}}
+
+For large sets of data it might even make sense to split the data up before compressing, so that it gets sent in separate chunks and the compressing is done in a separate thread from sending:
+{{{
+cs.attach('w' => 'r') {
+        tie('dataOut', 'dataIn',['serialize','chunk_16','compress','thread'],['decompress','dechunk_16','deserialize'])
 }
 }}}