Polymorphic actor classes.
- Ptolemy II 0.2
Interface Summary Interface Description ExceptionSubscriberAn ExceptionSubscriber is an entity that is informed of exceptions and the handling policy for exceptions caught by
SequenceActorThis is a marker interface for actors that operate on sequences.
Class Summary Class Description AbsoluteValueProduce an output token on each firing with a value that is equal to the absolute value of the input. AccumulatorOutput the initial value plus the sum of all the inputs since the last time a true token was received at the reset port. AddSubtractA polymorphic adder/subtractor. ArrayAccumulateAn actor that accumulates input arrays into a growing array that includes the contents of all input arrays. ArrayAppendAn actor that appends ArrayTokens together. ArrayAverageCompute the average of the elements in an array. ArrayContainsDetermine whether an element is contained in an array. ArrayElementExtract an element from an array. ArrayElementAsMatrixExtract an element from an array by accessing the array as a matrix. ArrayExtractExtract a subarray from an array. ArrayLengthOutput the length of an array. ArrayLevelCrossingSearch an array from the specified starting index and report the index of the first item in the array that is below or above the specified threshold. ArrayMaximumExtract the maximum element from an array. ArrayMinimumExtract the minimum element from an array. ArrayPeakSearchThis actor outputs the indices and values of peaks in an input array. ArrayRemoveElementRemove occurrences of a specified element from an array. ArraySortSort the elements of an input array. ArraySumCompute the sum of the elements in an array. ArrayToElementsAn actor that disassembles an ArrayToken to a multiport output. ArrayToMatrixConvert an array to a row or column vector encoded as a matrix token. ArrayUpdateReplace an element in an array with a new value. AssertCheck that an assertion predicate is satisfied, and throw an exception if not. Assert.AssertPortClass for ports created by the user for this actor. AverageOutput the average of the inputs after the last time a true token is received at the reset port. BernoulliProduce a random sequence of booleans. BooleanMultiplexorA multiplexor with a boolean-valued select control signal. BooleanSelectConditionally merge the streams at two input ports depending on the value of the boolean control input. BooleanSwitchSplit an input stream onto two output ports depending on a boolean control input. BusAssemblerAggregate all input relation channels into one output "bus" relation. BusDisassemblerSplit the input bus relation into individual (possibly bus) output port relations. CatchExceptionAttributeThis attribute catches exceptions and attempts to handle them with the specified policy. ClassWrapperThis actor wraps (an instance of) a Java class specified by the className parameter. Clock Deprecated.Use DiscreteClock. CommutatorA polymorphic commutator, which merges a set of input sequences into a single output sequence. ComputeHistogramCompute a histogram. ConfigurationSelectConditionally merge the streams at two input ports depending on the value of the boolean parameter. ConfigurationSwitchSplit an input stream onto two output ports depending on a boolean selector parameter. ConstProduce a constant output. CounterThis actor implements an up-down counter of received tokens. CurrentDateProduce an output token on each firing with a value that is the current date. CurrentMicrostepProduce an output token on each firing with a value that is the current microstep, also called the current index, of superdense time. CurrentTimeProduce an output token on each firing with a value that is the current time. DateConstructorConstruct date token by parsing all date elements (year, day, month, ...). DateElementsOutput elements of date (year, month, day, hour, etc.) from date. DBProduce a token that is the value of the input in decibels. DefaultA Synchronous default operator. DelayStartThis actor, which has no ports, delays the execution of the model until a specified time by sleeping the thread that calls the initialize() method until the specified time. DictionaryA store for key-value pairs. DifferentialOutput the current input minus the previous input, or if there has been no previous input, the current input itself. DiscardA simple sink actor that consumes and discards input tokens. DiscreteClockThis actor produces a periodic signal, a sequence of events at regularly spaced intervals. DiscreteRandomSourceAn actor that produces tokens with a given probability mass function. DistributorA polymorphic distributor, which splits an input stream into a set of output streams. DoubleReader Deprecated.Use ExpressionReader instead. ElementsToArrayOn each firing, this actor reads exactly one token from each channel of the input port and assembles the tokens into an ArrayToken. ExceptionManagerThe ExceptionManager catches exceptions and attempts to handle them with the specified policy. ExceptionManagerModelA composite entity that is the model contained by an ExceptionManager. ExecExecute a command as a separately running subprocess. ExecutionTimeRead the input token, if there is one, execute an (uninteresting) computation to consume a specified amount of real time or to execute it a fixed number of times, and produce on the output the actual execution time (in milliseconds). ExitA simple sink actor that consumes and discards input tokens and then calls System.exit() in wrapup. ExpressionOn each firing, evaluate an expression that may include references to the inputs, current time, and a count of the firing. FileWriterThis actor reads tokens from any number of input channels and writes their string values to the specified output file. GaussianProduce a random sequence with a Gaussian distribution. GetCausalityInterfaceActor that reads the causality interface of its container or an actor inside the container and produces a string describing it. GradientAdaptiveLatticeAn adaptive FIR filter with a lattice structure. IIRThis actor is an implementation of an infinite impulse response IIR filter. InterpolatorProduce an interpolation based on the parameters. LatticeAn FIR filter with a lattice structure. LevinsonDurbinThis actor uses the Levinson-Durbin algorithm to compute the linear predictor coefficients of a random process, given its autocorrelation function as an input. LimitedFiringSourceBase class for source actors that will only fire a limited number of times. LimiterProduce an output token on each firing with a value that is equal to the input if the input lies between the bottom and top parameters. LinearDifferenceEquationSystemLinear Difference Equation System. LookupTableOutput to the output port the value in the array of tokens specified by the table parameter at the index specified by the input port. MathFunction Deprecated.This breaks the class mechanism. MatrixToArrayConvert a matrix to an array. MaximumRead at most one token from each input channel and broadcast the one with the greatest value to the maximumValue output. MaxIndex Deprecated.Use Maximum instead. MicrostepDelayThis actor delays the input by one microstep. MinimumRead at most one token from each input channel and broadcast the one with the least value to the minimumValue output. ModifyDateModify date by adding or subtracting a value to one of the date fields. MovingAverageThis actor outputs the moving average of the input sequence. MovingMaximum Deprecated.Use RunningMaximum. MultiplexorThis actor selects from the channels on the input port, copying the input from one channel to the output, based on the most recently received value on the select input. MultiplyDivideA polymorphic multiplier and/or divider. NonStrictTestThis actor compares the inputs against the value specified by the correctValues parameter. OrderedMergeThis actor merges two monotonically nondecreasing streams of tokens into one monotonically nondecreasing stream. OrderedRecordAssemblerOn each firing, read one token from each input port and assemble them into a RecordToken. PauseAn actor that pauses execution of a model when it receives a true token on any input channel. PhaseUnwrapThis actor unwraps a phase plot, removing discontinuities of magnitude 2*PI. PoissonClockThis actor produces discrete events according to a Poisson process. PublisherThis actor publishes input tokens on a named channel. PublisherNonStrictTestThis actor publishes input tokens on a named channel and compares the inputs against the value specified by the correctValues parameter. PublisherTestThis actor publishes input tokens on a named channel and compares the inputs against the value specified by the correctValues parameter. PulseProduce a pulse with a shape specified by the parameters. QuantizerProduce an output token on each firing with a value that is a quantized version of the input. RampProduce an output token on each firing with a value that is incremented by the specified step each iteration. RandomIntegerGenerated integers that are uniformly sampled from the range of 32-bit integers. RandomSourceA base class for sources of random numbers. Reader Deprecated.Use ExpressionReader instead. RecordAssemblerOn each firing, read one token from each connected input port and assemble them into a RecordToken. RecordDisassemblerOn each firing, read one RecordToken from the input port and send out the fields of the RecordToken to multiple output ports. RecorderRecord all input tokens for later querying. RecordUpdaterOn each firing, read one token from each input port and assemble them into a RecordToken that contains the union of the original input record and each of the update ports. RecursiveLatticeA recursive (all-pole) filter with a lattice structure. RemainderCompute the remainder after dividing the input by the divisor. RemoveNilTokensRead in tokens and silently discard any tokens that are marked as nil. ResettableTimerProduce an output after the time specified on the input has elapsed. RicianProduce a random sequence with a Rician distribution. RunningMaximumOutput the maximum value seen since the start of execution of the model. RunningMinimumOutput the minimum value seen since the start of execution of the model. SamplerThis actor generates discrete events by sampling the input signal whenever the trigger input is present. ScaleProduce an output token on each firing with a value that is equal to a scaled version of the input. SelectA polymorphic select, which routes specified input channels to the output. SequenceThis actor produces a sequence of values, optionally periodically repeating them. SequencerThis actor takes a sequence of inputs tagged with a sequence number and produces them on the output port in the order given by the sequence number. SequenceSourceBase class for sequence sources. SequentialClock Deprecated.Use Clock instead. SetVariableSet the value of a variable. SingleEventThis actor produces an event with the specified value at the specified time. SingleTokenCommutatorThe SingleTokenCommutator has a multiport input port and an output port. SinkBase class for simple data sinks. SleepOn each firing, read at most one token from each input channel, sleep by the specified amount of real time, and then produce the same input tokens on the respective output channels. SourceBase for simple data sources. StopAn actor that stops execution of a model when it receives a true token on any input channel. StringConstProduce a constant output of type string. SubMatrixThis actor extract a submatrix from an input matrix. SubscriberThis actor subscribes to tokens on a named channel. SubscriptionAggregatorAggregate data produced by multiple publishers. SwitchA polymorphic switch, which routes inputs to specified output channels. SynchronizerThis actor implements a token synchronizer. SynchronizeToRealTimeAttribute that regulates the passage of time to wait for real time to catch up. TestThis actor compares the inputs against the value specified by the correctValues parameter. TestExceptionAttributeThis actor tests for exceptions that are expected to occur when running a test model. TestExceptionHandler Deprecated.Use
ThrowExceptionAn actor that throws an IllegalActionException when it receives a true token on any input channel. ThrowModelErrorAn actor that throws a model error when it receives a true token on any input channel. TimeDelayThis actor delays the input by a specified amount of time given by the delay port or parameter, which defaults to 1.0. TimeDelay.PendingEventData structure to store pending events. TimedSourceBase class for time-based sources. TopLevelCurrentTime Deprecated.Use CurrentTime with useLocalTime unchecked. TransformerThis is an abstract base class for actors that transform an input stream into an output stream. TriangularProduce a random sequence with a triangular distribution. TrigFunctionProduce an output token on each firing with a value that is equal to the specified trigonometric function of the input. TriggeredClock Deprecated.Use DiscreteClock. TypeTestAn actor that can be used for regression test of the type resolution system. UnaryMathFunctionProduce an output token on each firing with a value that is equal to the specified math function of the input. UniformProduce a random sequence with a uniform distribution. UnionDisassemblerOn each firing, read one UnionToken from the input port and send out the value to the output port that matches the label name of the input token. UnionMergeOn each firing, read all tokens from every input port and wrap each token into a UnionToken of which the label matches the name of the originating input port. URLDirectoryReader Deprecated.Use DirectoryListing instead. URLReaderThis actor reads tokens from an URL, and output them. VariableClock Deprecated.Use Clock instead. VariableSleepAn actor that calls Thread.sleep() on the current thread the first time fire() is called. VectorAssemblerOn each firing, read exactly one token from each channel of the input port and assemble the tokens into a DoubleMatrixToken with one column. VectorDisassemblerAn actor that disassembles a DoubleMatrixToken to a multiport output. WallClockTimeUpon firing, this actor outputs the elapsed real time in seconds since the start time of the model, as reported by the director. Writer Deprecated.FileWriter actor replaces this.