ptolemy.actor

Interface Actor

All Superinterfaces:

Executable, Initializable, Nameable

All Known Subinterfaces:

BranchActor, GTCompositeActor, InferenceActor, MapConstrained, RefinementActor, StateSpaceActor, TMActor, TypedActor, WirelessChannel

All Known Implementing Classes:

Absent, AbsoluteValue, AbstractCalInterpreter, AbstractParticleFilter, AbstractPlaceableActor, AbstractPredictor, AbstractSourceStation, AbstractStateSpaceSimulator, AbstractStation, AbstractTrack, AbstractUnscentedKalmanFilter, Accelerometer, AccumLUB, Accumulator, Accumulator, ActorRecursion, ActuatorSetup, AdaptiveMedian, AddSubtract, AddSubtract, AddSubtractAll, AFDXESs, AFDXSwitch, AFTEDiscriminant, AFTEFast, Airport, Align, Alloc, AnythingToDouble, ApplyFilterOverArray, ApplyFunction, ApplyFunctionOverSequence, ArrayAccumulate, ArrayAppend, ArrayAverage, ArrayContains, ArrayElement, ArrayElementAsMatrix, ArrayExtract, ArrayLength, ArrayLevelCrossing, ArrayMaximum, ArrayMinimum, ArrayOfRecordsExporter, ArrayOfRecordsRecorder, ArrayPeakSearch, ArrayPeakSearch, ArrayPlotter, ArrayPlotterXY, ArrayRemoveElement, ArraySort, ArraySum, ArrayToElements, ArrayToMatrix, ArrayToSequence, ArrayUpdate, ArrowKeyProbe, ArrowKeySensor, Assert, AtomicActor, AtomicActorMatcher, AtomicCommunicationAspect, AtomicContinuationActor, AtomicExecutionAspect, AtomicWirelessChannel, AudioCapture, AudioPlayer, AudioPlayer, AudioReadBuffer, AudioReader, AudioWriteBuffer, AudioWriter, Autocorrelation, Autocorrelation, Average, Average, AverageOverTime, BackDropQueue, Backtrack, BandlimitedNoise, BarGraph, Barrier, Barrier, BaseMultipleMethodsActor, BasicSwitch, Bernoulli, BinaryNonStrictLogicGate, BinarySwitch, BitsToInt, BluetoothDevice, BooleanMultiplexor, BooleanSelect, BooleanSelect, BooleanSwitch, BooleanSwitch, BooleanToAnything, BootstrapSampleDelay, BoundedBufferNondeterministicDelay, BoundedBufferTimedDelay, BoundingBox, Box2D, Box3D, Break, Buffer, Buffer, Bus, BusAssembler, BusDisassembler, ButtonTime, CA2DConvolution, CActorBase, CalInterpreter, CanBus, CanBusPriority, CartesianToComplex, CartesianToPolar, Case, Case, CatchUpComposite, CatchUpComposite.Contents, CAViewer, CC3000Control, CC3000Module, ChangePtr, Chop, Chop, ChordFollower, ChordParser, CIActor, CipherActor, CircularSweep3D, ClassWrapper, ClipPlayer, Clock, CollisionDetector, ColorFinder, ColtBeta, ColtBinomial, ColtBinomialSelector, ColtBreitWigner, ColtChiSquare, ColtExponential, ColtExponentialPower, ColtGamma, ColtHyperGeometric, ColtLogarithmic, ColtNegativeBinomial, ColtNormal, ColtPoisson, ColtPoissonSlow, ColtRandomSource, ColtStudentT, ColtVonMises, ColtZeta, Combine, CommunicationAspectMonitor, CommunicationRequestPort, CommunicationResponsePort, Commutator, Commutator, Comparator, CompiledCompositeActor, ComplexAddSubtract, ComplexToCartesian, ComplexToPolar, CompositeActor, CompositeActorMatcher, CompositeCommunicationAspect, CompositeExecutionAspect, CompositeOptimizer, CompositeOptimizer.OptimizerComposite, CompositeOptimizerUsingGradient, CompositeOptimizerUsingGradient.OptimizerComposite, ComputeHistogram, ComputeHistogram, Concat, Conditional, Cone3D, ConfigurationSelect, ConfigurationSwitch, Configurer, Const, ConstPlaceable, ConstraintsCalculator, ContinuousIntegrator, ContinuousMerge, ContinuousTimeDelay, ContinuousTransferFunction, ControlActor, Converter, ConvertParticlesToCovarianceMatrix, ConvolutionalCoder, CorbaActorClient, Counter, Counter, Counter, CountTrues, Course, CovarianceStatePredictor, CrossbarSwitch, CryptographyActor, CSPActor, CSPBuffer, CSPMultiSink, CSPMultiSource, CSPSieve, CSPSink, CSPSource, CSVReader, CSVWriter, Current, CurrentDate, CurrentMicrostep, CurrentTime, Cylinder3D, DatabaseInsert, DatabaseManager, DatabaseQuery, DatabaseSelect, DatagramReader, DatagramWriter, DateConstructor, DateElements, DateToEvent, DateToModelTime, DateToString, DB, DB, DCT2x2dc, DCT4x4dc, DCT8x8, DDEActor, DDESink, DDFBooleanSelect, DDFOrderedMerge, DDFSelect, DDFSingleTokenCommutator, DEActor, Default, DelayChannel, DelayLine, DelayLine, DelayStart, Derivative, Derivative, DeScrambler, DestinationAirport, DEThreadActor, DETransformer, Dictionary, Differential, Differential, DifferentialSystem, DirectoryListing, Discard, DiscardDoubles, DiscardDoublesArray, DiscardGenerals, DiscreteClock, DiscreteClock, DiscreteRandomSource, Display, DisplayAll, DistributedLineWriter, DistributedTypedCompositeActor, Distributor, Distributor, DotProduct, DoubleFork, DoubleMatrixToJAI, DoubleReader, DoubleReader, DoubleToFix, DoubleToMatrix, DownSample, DropSensorHandler, DummyDisplay, DummySource, DummyTransformer, DynamicCoreAssignmentScheduler, EDFScheduler, ElementsToArray, Ellipse2D, EmbeddedCodeActor, EmbeddedCodeActor.EmbeddedActor, Emit, EnabledComposite, EncoderHandler, Equals, ErasureChannel, EventButton, EventButton, EventFilter, EventSource, EventToDate, Excel, Exec, ExecuteActor, ExecuteCompositeActor, ExecutionRequestPort, ExecutionResponsePort, ExecutionTime, Exit, Expression, ExpressionReader, ExpressionToToken, ExpressionWriter, FactorOracle, FactorOracleGenerator, FactorOracleTop, FCFSScheduler, FeedBackDelay, FFT, FFT, FileReader, FileWriter, FIR, FixComparator, FixConst, FixCounter, FixedPriorityScheduler, FixSequence, FixToDouble, FixToFix, FixToString, FixTransformer, FMUImport, FMUImportHybrid, FMUQSS, FmvAutomaton, FrontDropQueue, FSMActor, FSMMatcher, Gaussian, Gaussian, GaussianMeasurementModel, Gem5Wrapper, GestureRecognition, GetCausalityInterface, GetCurrentMicrostep, GetProperties, GPInputHandler, GPIOWriter, GPOutputSetup, GRActor, GRActor2D, GRActor3D, GradientAdaptiveLattice, GradientAdaptiveLattice, GraphicalLocator, GRShadedShape, GRShape2D, GRTransform, GRTransform2D, HadamardCode, HammingCoder, HammingDecoder, HistogramPlotter, HlaPublisher, HlaSubscriber, HMMExponentialClassifier, HMMExponentialEstimator, HMMGaussianClassifier, HMMGaussianEstimator, HMMGaussianEstimator, HMMMultinomialClassifier, HMMMultinomialEstimator, HSBtoRGB, HSMMGaussianEstimator, HSMMGenerator, HSMMGeneratorGaussianEmissions, HSMMGeneratorMultinomialEmissions, HSMMMultinomialEstimator, HSMMParameterEstimator, HSMMTimeAwareGenerator, HSMMTimeAwareMultinomialEstimator, HSMMTimeAwareMultinomialEstimatorWithCodegen, HTMLModelExporter, HTMLPageAssembler, HttpActor, HttpGet, HttpPost, HttpPost, HttpPut, HttpPut, HttpRequestHandler, HttpSink, HTVQEncode, HuffmanBasic, HuffmanCoder, HuffmanDecoder, IDCT4x4dc, IDCT8x8, IFFT, IFFT, IfThen, IfThenElse, IIR, IIR, Image2D, ImageContrast, ImageDisplay, ImageDisplay, ImagePartition, ImageReader, ImageRotate, ImageSequence, ImageToJAI, ImageToJMF, ImageToString, ImageToString, ImageUnpartition, ImageWriter, Inhibit, InputDevice, InstantaneousDialogGenerator, IntArrayToString, IntegerCounter, Integrator, Integrator, InteractiveDialog, InteractiveShell, InterfaceAutomaton, Interpolator, Interpolator, IntToBits, InUnitsOf, InverseSourceStation, InverseStation, InverseTrack, IPAddress, IsPresent, IterateOverArray, IterateOverArray.IterateComposite, JAIAffineTransform, JAIBandCombine, JAIBandSelect, JAIBMPWriter, JAIBorder, JAIBoxFilter, JAIConstant, JAIConvolve, JAICrop, JAIDataConvert, JAIDCT, JAIDFT, JAIEdgeDetection, JAIIDCT, JAIIDFT, JAIImageReader, JAIInvert, JAIJPEGWriter, JAILog, JAIMagnitude, JAIMedianFilter, JAIPeriodicShift, JAIPhase, JAIPNGWriter, JAIPNMWriter, JAIPolarToComplex, JAIRotate, JAIScale, JAITIFFWriter, JAIToDoubleMatrix, JAITranslate, JAITranspose, JAIWriter, JavaScript, JopReadPort, JopSerialRead, JopSerialWrite, JopWatchDog, JopWritePort, Joystick, JSAccessor, JSONToToken, KeyInput3D, KeyInput3DProbe, KeyReader, KeyStoreActor, KeyWriter, KMeans, LabVIEWSimulator, Lattice, LazyTypedCompositeActor, LEDCubeUpdate, LEDMatrix, LempelZivCoder, LempelZivDecoder, LevelCrossingDetector, LevinsonDurbin, LifeCycleManager, LimitedFiringSource, LimitedRangeChannel, Limiter, Line2D, LinearDifferenceEquationSystem, LinearDifferenceEquationSystem, LinearStateSpace, LineCoder, LineReader, LineWriter, LinkVisualizer, LiveSoundActor, LMSAdaptive, Load, Loader3D, LoadStore, Locator, LogicalNot, LogicalNot, LogicFunction, LogicFunction, LogicGate, LongToDate, LongToDouble, LookupTable, LuminarySensorHandler, Map, MapFileStorage, MapWorker, MathFunction, MatrixJoin, MatrixSplit, MatrixToArray, MatrixToDouble, MatrixToSequence, MatrixViewer, Maximum, MaxIndex, MeasurementModel, Memory, MemoryAccess, Merge, Merge, MetroIICompositeActor, MetroIIMirrorComposite, MetroIIMirrorComposite.MetroIIMirrorCompositeContents, MetroIIModalModel, MetroIIPtidesPlatform, MetroIIPtidesPlatform.PtidesPlatformContents, MicaCompositeActor, MicaLeds, MicrostepDelay, MidiKeyToNote, Minimum, MirrorComposite, MirrorComposite.MirrorCompositeContents, MirrorDecorator, MobileFunction, MobileModel, ModalController, ModalModel, ModalModelMatcher, ModalRefinement, ModelCombine, ModelDisplay, ModelExecutor, ModelGenerator, ModelReference, ModelView, ModifyDate, ModularCodeGenLazyTypedCompositeActor, ModularCodeGenTypedCompositeActor, ModularCompiledSDFTypedCompositeActor, MoMLGenerator, MonitorImage, MonitorValue, MostRecent, MotorSetup, MouseInput3D, MovableViewScreen3D, MovieReader, MovieWriter, MovingAverage, MovingMaximum, MultiCompositeActor, MultiInstanceComposite, Multiplexor, Multiplexor, Multiplexor, Multiplier, MultiplyDivide, MutualInformationCalculator, NCComponentBase, NCCompositeActor, NeoPixelLEDStrip, NodeRandomizer, Noise, Noise, NondeterministicMerge, NonInterruptibleTimer, NonStrictAndGate, NonStrictDelay, NonStrictDisplay, NonStrictLogicFunction, NonStrictLogicGate, NonStrictOrGate, NonStrictTest, NonStrictThreeBitAdder, NonStrictXorGate, NoteParser, NoteToMidiKey, ObservationClassifier, Occupants, Optimizer, Or, OracleModel, OrderedMerge, OrderedMerge, OrderedRecordAssembler, OscReceiver, OscSender, OutputDevice, PacketDropFaultGenerator, PacketToSensorData, ParameterEstimator, ParameterEstimator, ParticleFilter, ParticleFilter, ParticleFilterRange, ParticleMutualInformation, Pattern, Pause, Pause, PeriodicSampler, PetriNetActor, PetriNetDisplay, PetriNetRecorder, PGMReader, PhaseUnwrap, PhaseUnwrap, PID, Place, PlaySound, Plotter, PlotterBase, PoissonClock, PoissonClock, PolarToCartesian, PolarToComplex, PolyCylinder3D, PositionConstraintCalculator, PowerLossChannel, Pre, Predictor, Previous, PrivateKeyReader, ProxyActor, ProxySink, ProxySource, PSNR, PtalonActor, PtalonMatcher, PtalonMatcher.NestedPtalonActor, PteraController, PteraModalModel, PthalesAddHeaderActor, PthalesAtomicActor, PthalesCompositeActor, PthalesDynamicCompositeActor, PthalesGenericActor, PthalesRemoveHeaderActor, PthalesWrapperCompositeActor, PtidesPlatform, PtidesPlatform.PtidesPlatformContents, PtinyOSCompositeActor, PublicKeyReader, Publisher, PublisherNonStrictTest, PublisherTest, PullConsumer, PullSupplier, Pulse, Pulse, PushConsumer, PushSupplier, PythonScript, QSSIntegrator, QSSIntegrator, QuantizedSampler, Quantizer, Queue, Queue, RaisedCosine, Ramp, Ramp, RandomInteger, RandomSource, RandomSource, Reader, RealTimeComposite, RealTimePlotter, RecordAssembler, RecordDisassembler, Recorder, Recorder, RecordToQueryString, RecordUpdater, Rectangle2D, RectangularFigure2D, RecursiveLattice, RecursiveLattice, ReduceWorker, Refinement, Refinement, ReflectComposite, ReflectComposite.ReflectCompositeContents, Region, Register, Register, RegisterSR, Remainder, RemoveNilTokens, Repeat, Replacement, ResettableTimer, ResourcePool, ResourcePool, RESTGetHandler, RExpression, RExpression2, Rician, ROM, Room, Rotate2D, Rotate3D, Round, RunCompositeActor, RunningMaximum, RunningMinimum, SaltAndPepper, SampleDelay, Sampler, Scale, Scale2D, Scale3D, Scrambler, SCRModel, SDFConverter, SDFTransformer, SecretKey, SecretKeyReader, Select, Select, SendMail, SensorDataCalibration, SensorHandler, Sequence, Sequence, SequencedIntegrator, SequencedSharedMemoryActor, SequencedVariable, SequencePlotter, Sequencer, Sequencer, SequenceScope, SequenceSource, SequenceToArray, SequenceToMatrix, SequentialClock, SequentialClock, SerialComm, Server, SetProperties, SetVariable, SharedBufferTransformer, SharedQueue, SignatureActor, SignatureSigner, SignatureVerifier, Simulator, SingleEvent, SingleTokenCommutator, SingleTokenDistributor, Sink, SketchedSource, Sleep, Slice, Slicer, SliderSource, SmoothSignal, SmoothToDouble, SmoothZeroCrossingDetector, SMVLegacyCodeActor, SongWrapper, SoundActor, SoundPlayer, Source, SourceStation, SpeakerOutputDevice, Sphere3D, SplitReader, SQLStatement, Starver, StateMatcher, StatePredictorWithAccControl, StatePredictorWithControl, StateSpaceModel, StateSpaceSimulator, Station, StationWriter, Stop, Store, StormHandling, StreamLoader, StringCompare, StringConst, StringFunction, StringIndexOf, StringLength, StringMatches, StringReplace, StringSimpleReplace, StringSplit, StringSubstring, StringToBoolean, StringToDate, StringToDouble, StringToInt, StringToIntArray, StringToKeyValue, StringToUnsignedByteArray, StringToXML, StuckAtFaultGenerator, SubMatrix, Subscriber, SubscriptionAggregator, SumofAbsoluteDifferences, SuppressSimultaneousEvents, SurgeVisualizer, Switch, Switch, SymmetricCrypto, SymmetricDecryption, SymmetricEncryption, Synchronizer, SynchronousFixTransformer, SystemCommand, Task, TaskCoordinator, TaskReceiver, TaskReporter, TCPPacketReceiver, TCPPacketTransmitter, TDLActor, TDLController, TDLModule, TDLRefinement, TDLTask, TerrainProperty, Test, TestActorPortDepth, TestExceptionHandler, TextString3D, ThreadedComposite, ThrowException, ThrowModelError, TimeCompare, TimedDelay, TimedDisplay, TimeDelay, TimedMonitorValue, TimedPlotter, TimedScope, TimedSource, TimeGap, Timer, TimeTriggeredEncoderHandler, TMCompositeFacade, TokenReader, TokenToExpression, TokenToJSON, TopLevelCurrentTime, Torus3D, Track, Track, TrackWriter, Transform.EmbeddedConfigurer, TransformationRule, Transformer, Transition, TransitionRefinement, Translate2D, Translate3D, TransmitPropertyTransformer, TrellisDecoder, Triangular, Triangulator, TrigFunction, TriggeredClock, TrueGate, TTESwitch, TypedAtomicActor, TypedCompositeActor, TypeOpaqueCompositeActor, TypeTest, UnaryMathFunction, Undefined, Uniform, UnionDisassembler, UnionMerge, UnitsConverter, UnscentedKalmanFilterSSM, UnsignedByteArrayToString, UpSample, URLDirectoryReader, URLReader, URLToImage, VariableClock, VariableDelay, VariableDelaySwitch, VariableFIR, VariableLattice, VariableRecursiveLattice, VariableSleep, VectorAssembler, VectorDisassembler, Video, VideoCamera, VideoPlayer, ViewLayers3D, ViewScreen2D, ViewScreen3D, VisualModelReference, ViterbiDecoder, VQDecode, WaitingTime, WallClockTime, Waveform, WebSocketReader, WebSocketWriter, When, While, Wire, Wire, WiredToWireless, WirelessComposite, WirelessToWired, Writer, XMLInclusion, XMPPSink, XMPPSource, XSLTransformer, XYPlotter, XYScope, ZeroOrderHold

public interface Actor
extends Executable, Nameable

An Actor is an executable entity. This interface defines the common functionality in AtomicActor and CompositeActor.

Since:

Ptolemy II 0.2

Version:

$Id$

Author:

Edward A. Lee

See Also:

CompositeActor, AtomicActor

Pt.AcceptedRating:

Green (davisj)

Pt.ProposedRating:

Green (eal)

Field Summary

Fields inherited from interface ptolemy.actor.Executable

COMPLETED, NOT_READY, STOP_ITERATING

Method Summary

Modifier and Type	Method and Description
void	createReceivers() Create receivers for all necessary ports.
CausalityInterface	getCausalityInterface() Return a causality interface for this actor.
Director	getDirector() Return the local director, if there is one, otherwise the executive director, if there is one, otherwise null.
Director	getExecutiveDirector() Return the executive director, if there is one, otherwise return null.
Manager	getManager() Return the Manager, if there is one.
java.util.List	inputPortList() Return a list of the input ports of this actor.
Receiver	newReceiver() Return a new receiver of a type compatible with the executive director.
java.util.List	outputPortList() Return a list of the output ports of this actor.

Methods inherited from interface ptolemy.actor.Executable

fire, isFireFunctional, isStrict, iterate, postfire, prefire, stop, stopFire, terminate

Methods inherited from interface ptolemy.actor.Initializable

addInitializable, initialize, preinitialize, removeInitializable, wrapup

Methods inherited from interface ptolemy.kernel.util.Nameable

description, getContainer, getDisplayName, getFullName, getName, getName, setName

Method Detail

createReceivers

void createReceivers()
              throws IllegalActionException

Create receivers for all necessary ports. For Atomic Actors this is done for each input port, for Composite Actors for both the input and the output ports.

Throws:

IllegalActionException - If any port throws it.

See Also:

AtomicActor.createReceivers(), CompositeActor.createReceivers()

getDirector

Director getDirector()

Return the local director, if there is one, otherwise the executive director, if there is one, otherwise null.

Returns:

The director.

getExecutiveDirector

Director getExecutiveDirector()

Return the executive director, if there is one, otherwise return null.

Returns:

The executive director.

getCausalityInterface

CausalityInterface getCausalityInterface()
                                  throws IllegalActionException

Return a causality interface for this actor.

Returns:

A representation of the dependencies between input ports and output ports.

Throws:

IllegalActionException - Thrown if causality interface cannot be computed.

getManager

Manager getManager()

Return the Manager, if there is one. Otherwise, return null.

Returns:

The Manager.

inputPortList

java.util.List inputPortList()

Return a list of the input ports of this actor. Note that implementations should return ports directly contained by this actor, whether they are transparent or not.

Returns:

A list of input IOPort objects.

newReceiver

Receiver newReceiver()
              throws IllegalActionException

Return a new receiver of a type compatible with the executive director. This is the receiver that should be used by ports of this actor.

Returns:

A new object implementing the Receiver interface.

Throws:

IllegalActionException - If there is no director.

outputPortList

java.util.List outputPortList()

Return a list of the output ports of this actor. Note that implementations should return ports directly contained by this actor, whether they are transparent or not.

Returns:

A list of output IOPort objects.