Package org.jcsp.plugNplay
Class Regulate
java.lang.Object
org.jcsp.plugNplay.Regulate
- All Implemented Interfaces:
CSProcess
This process controls the rate of flow of traffic from its input to output channels.
Process Diagram
in ____________________________ --->---| | out reset | Regulate (initialInterval) |-->-- --->---|____________________________|
Description
Regulate produces a constant rate of output flow, regardless of the rate of its input. At the end of each time period, it outputs the last object input during that period. If nothing comes in, the previous output will be repeated (note: this will be a null if nothing has ever arrived). If the input flow is greater than the required output flow, data will be discarded.The interval (in msecs) defining the output flow rate is given by a constructor argument. This can be changed at any time by sending a new interval (as a Long) down its reset channel.
Channel Protocols
Input Channels | ||
---|---|---|
in | java.lang.Object | This accepts data of any Class. |
reset | java.lang.Long | This resets the time interval between outputs (milliseconds). |
Output Channels | ||
out | java.lang.Object | This carries samples from the input data, sampled at the defined rate. |
Implementation
See here.- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final AltingChannelInput
private final long
private final ChannelOutput
private final AltingChannelInput
-
Constructor Summary
ConstructorsConstructorDescriptionRegulate
(AltingChannelInput in, AltingChannelInput reset, ChannelOutput out, long initialInterval) Construct the process. -
Method Summary
-
Field Details
-
in
-
reset
-
out
-
initialInterval
private final long initialInterval
-
-
Constructor Details
-
Regulate
public Regulate(AltingChannelInput in, AltingChannelInput reset, ChannelOutput out, long initialInterval) Construct the process.- Parameters:
in
- the input channelout
- the output channelinitialInterval
- the initial interval between outputs (in milliseconds)reset
- send a Long down this to change the interval between outputs (in milliseconds)
-
-
Method Details