Package ptolemy.domains.pthales.lib

Class PthalesGenericActor

java.lang.Object

ptolemy.kernel.util.NamedObj

ptolemy.kernel.InstantiableNamedObj

ptolemy.kernel.Entity<T>

ptolemy.kernel.ComponentEntity<T>

ptolemy.actor.AtomicActor<TypedIOPort>

ptolemy.actor.TypedAtomicActor

ptolemy.domains.pthales.lib.PthalesAtomicActor

ptolemy.domains.pthales.lib.PthalesGenericActor

All Implemented Interfaces:

java.lang.Cloneable, Actor, Executable, FiringsRecordable, Initializable, TypedActor, Changeable, Debuggable, DebugListener, Derivable, Instantiable, ModelErrorHandler, MoMLExportable, Moveable, Nameable

public class PthalesGenericActor
extends PthalesAtomicActor

An element of ArrayOL in Ptolemy.

ArrayOL "is a high-level visual language dedicated to multidimensional intensive signal processing applications."

In the name of this actor, "Generic" means that the same actor is used to implement different functions. This actor calls a JNI function when fired, with arguments in correct orders. These function and arguments are parameters of the actor.

For details about ArrayOL, see: P. Boulet, Array-OL Revisited, Multidimensional Intensive Signal Processing Specification,INRIA, Sophia Antipolis, France, 2007.

Since:

Ptolemy II 10.0

Version:

$Id$

Author:

Remi Barrere

See Also:

TypedAtomicActor

Pt.AcceptedRating:

Red (cxh)

Pt.ProposedRating:

Red (cxh)

Nested Class Summary

Nested classes/interfaces inherited from class ptolemy.kernel.Entity

Entity.ContainedObjectsIterator

Field Summary

Fields inherited from class ptolemy.domains.pthales.lib.PthalesAtomicActor

_INTERNAL_REPETITIONS, _REPETITIONS

Fields inherited from class ptolemy.actor.TypedAtomicActor

_typesValid

Fields inherited from class ptolemy.actor.AtomicActor

_actorFiringListeners, _initializables, _notifyingActorFiring, _stopRequested

Fields inherited from class ptolemy.kernel.util.NamedObj

_changeListeners, _changeLock, _changeRequests, _debugging, _debugListeners, _deferChangeRequests, _elementName, _isPersistent, _verbose, _workspace, ATTRIBUTES, CLASSNAME, COMPLETE, CONTENTS, DEEP, FULLNAME, LINKS

Fields inherited from interface ptolemy.actor.Executable

COMPLETED, NOT_READY, STOP_ITERATING

Constructor Summary

Constructors

Constructor	Description
PthalesGenericActor()	Construct an actor in the default workspace with an empty string as its name.
PthalesGenericActor(CompositeEntity container, java.lang.String name)	Create a new actor in the specified container with the specified name.
PthalesGenericActor(Workspace workspace)	Construct an actor in the specified workspace with an empty string as a name.

Method Summary

Modifier and Type	Method	Description
protected java.lang.Object[]	_convertArguments(float[][] in, float[][] out)	Function which convert a list of arguments into real arguments and length that will be used for JNI function call.
protected void	_initialize()	Set specific attributes common to all Pthales atomic actors.
void	fire()	Read the contents of the array and then call JNI function.
boolean	postfire()	Always return true in this base class, indicating that execution can continue into the next iteration.

Methods inherited from class ptolemy.domains.pthales.lib.PthalesAtomicActor

_computeIteration, _computeIterations, _parseRepetitions, convertReal, convertToken, getInternalRepetitions, getIteration, getIterations, getRepetitions, newPort

Methods inherited from class ptolemy.actor.TypedAtomicActor

_containedTypeConstraints, _customTypeConstraints, _defaultTypeConstraints, _fireAt, _fireAt, attributeTypeChanged, clone, clone, isBackwardTypeInferenceEnabled, typeConstraintList, typeConstraints

Methods inherited from class ptolemy.actor.AtomicActor

_actorFiring, _actorFiring, _declareDelayDependency, addActorFiringListener, addInitializable, connectionsChanged, createReceivers, declareDelayDependency, getCausalityInterface, getDirector, getExecutiveDirector, getManager, initialize, inputPortList, isFireFunctional, isStrict, iterate, newReceiver, outputPortList, prefire, preinitialize, pruneDependencies, recordFiring, removeActorFiringListener, removeDependency, removeInitializable, setContainer, stop, stopFire, terminate, wrapup

Methods inherited from class ptolemy.kernel.ComponentEntity

_adjustDeferrals, _checkContainer, _getContainedObject, _propagateExistence, getContainer, instantiate, isAtomic, isOpaque, moveDown, moveToFirst, moveToIndex, moveToLast, moveUp, propagateExistence, setName

Methods inherited from class ptolemy.kernel.Entity

_addPort, _description, _exportMoMLContents, _removePort, _validateSettables, connectedPortList, connectedPorts, containedObjectsIterator, getAttribute, getPort, getPorts, linkedRelationList, linkedRelations, portList, removeAllPorts, setClassDefinition, uniqueName

Methods inherited from class ptolemy.kernel.InstantiableNamedObj

_setParent, exportMoML, getChildren, getElementName, getParent, getPrototypeList, isClassDefinition, isWithinClassDefinition

Methods inherited from class ptolemy.kernel.util.NamedObj

_addAttribute, _adjustOverride, _attachText, _cloneFixAttributeFields, _containedDecorators, _copyChangeRequestList, _debug, _debug, _debug, _debug, _debug, _executeChangeRequests, _getIndentPrefix, _isMoMLSuppressed, _markContentsDerived, _notifyHierarchyListenersAfterChange, _notifyHierarchyListenersBeforeChange, _propagateValue, _removeAttribute, _splitName, _stripNumericSuffix, addChangeListener, addDebugListener, addHierarchyListener, attributeChanged, attributeDeleted, attributeList, attributeList, decorators, deepContains, depthInHierarchy, description, description, event, executeChangeRequests, exportMoML, exportMoML, exportMoML, exportMoML, exportMoMLPlain, getAttribute, getAttributes, getChangeListeners, getClassName, getDecoratorAttribute, getDecoratorAttributes, getDerivedLevel, getDerivedList, getDisplayName, getFullName, getModelErrorHandler, getName, getName, getSource, handleModelError, isDeferringChangeRequests, isOverridden, isPersistent, lazyContainedObjectsIterator, message, notifyOfNameChange, propagateValue, propagateValues, removeAttribute, removeChangeListener, removeDebugListener, removeHierarchyListener, requestChange, setClassName, setDeferringChangeRequests, setDerivedLevel, setDisplayName, setModelErrorHandler, setPersistent, setSource, sortContainedObjects, toplevel, toString, validateSettables, workspace

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface ptolemy.actor.Actor

createReceivers, getCausalityInterface, getDirector, getExecutiveDirector, getManager, inputPortList, newReceiver, outputPortList

Methods inherited from interface ptolemy.kernel.util.Derivable

getDerivedLevel, getDerivedList, propagateValue

Methods inherited from interface ptolemy.actor.Executable

isFireFunctional, isStrict, iterate, 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

Constructor Detail

PthalesGenericActor

public PthalesGenericActor()
                    throws IllegalActionException,
                           NameDuplicationException

Construct an actor in the default workspace with an empty string as its name. The object is added to the workspace directory. Increment the version number of the workspace.

Throws:

IllegalActionException - If the actor cannot be contained by the proposed container.

NameDuplicationException - If the container already has an actor with this name.

PthalesGenericActor

public PthalesGenericActor(CompositeEntity container,
                           java.lang.String name)
                    throws NameDuplicationException,
                           IllegalActionException

Create a new actor in the specified container with the specified name. The name must be unique within the container or an exception is thrown. The container argument must not be null, or a NullPointerException will be thrown.

Parameters:

container - The container.

name - The name of this actor within the container.

Throws:

IllegalActionException - If this actor cannot be contained by the proposed container (see the setContainer() method).

NameDuplicationException - If the name coincides with an entity already in the container.

PthalesGenericActor

public PthalesGenericActor(Workspace workspace)
                    throws IllegalActionException,
                           NameDuplicationException

Construct an actor in the specified workspace with an empty string as a name. You can then change the name with setName(). If the workspace argument is null, then use the default workspace. The object is added to the workspace directory. Increment the version number of the workspace.

Parameters:

workspace - The workspace that will list the entity.

Throws:

IllegalActionException - If the actor cannot be contained by the proposed container.

NameDuplicationException - If the container already has an actor with this name.

Method Detail

fire

public void fire()
          throws IllegalActionException

Read the contents of the array and then call JNI function.

Specified by:

fire in interface Executable

Overrides:

fire in class AtomicActor<TypedIOPort>

Throws:

IllegalActionException - If there is no director, or the input can not be read, or the output can not be sent.

postfire

public boolean postfire()
                 throws IllegalActionException

Always return true in this base class, indicating that execution can continue into the next iteration.

Specified by:

postfire in interface Executable

Overrides:

postfire in class AtomicActor<TypedIOPort>

Returns:

Always return true in this base class, indicating that execution can continue into the next iteration.

Throws:

IllegalActionException - Not thrown in this base class.

_initialize

protected void _initialize()
                    throws IllegalActionException,
                           NameDuplicationException

Description copied from class: PthalesAtomicActor

Set specific attributes common to all Pthales atomic actors.

Overrides:

_initialize in class PthalesAtomicActor

Throws:

IllegalActionException

NameDuplicationException

_convertArguments

protected java.lang.Object[] _convertArguments(float[][] in,
                                               float[][] out)

Function which convert a list of arguments into real arguments and length that will be used for JNI function call.

Parameters:

in - input arguments

out - output arguments

Returns:

A list of arguments to be used for the JNI function call.