Package org.ptolemy.machineImprovisation

Class OracleModel

java.lang.Object

ptolemy.kernel.util.NamedObj

ptolemy.kernel.InstantiableNamedObj

ptolemy.kernel.Entity<T>

ptolemy.kernel.ComponentEntity

ptolemy.kernel.CompositeEntity

ptolemy.actor.CompositeActor

ptolemy.actor.TypedCompositeActor

ptolemy.domains.modal.modal.ModalModel

ptolemy.domains.modal.modal.ModalRefinement

org.ptolemy.machineImprovisation.OracleModel

All Implemented Interfaces:

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

public class OracleModel
extends ModalRefinement

This modal model actor supports mirroring of its ports in its container (which is required to be a refinement of a state in a ModalModel). This in turn assures mirroring of ports in each of the refinements.

Note that this actor has no attributes of its own. Requests for attributes are delegated to the container.

Since:

Ptolemy II 10.0

Version:

$Id$

Author:

Ilge Akkaya

Pt.AcceptedRating:

Red (reviewmoderator)

Pt.ProposedRating:

Red (ilgea)

Nested Class Summary

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

CompositeEntity.ContainedObjectsIterator

Field Summary

Fields inherited from class ptolemy.domains.modal.modal.ModalRefinement

_mirrorDisable

Fields inherited from class ptolemy.domains.modal.modal.ModalModel

_controller, directorClass, stateDependentCausality

Fields inherited from class ptolemy.actor.CompositeActor

_actorFiringListeners, _causalityInterface, _derivedPiggybacks, _initializables, _notifyingActorFiring, _piggybacks, _publishedPorts, _publisherRelations, _stopRequested, _subscribedPorts

Fields inherited from class ptolemy.kernel.CompositeEntity

_levelCrossingLinks

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
OracleModel(CompositeEntity container, java.lang.String name)	Constructs an OracleModel object.
OracleModel(CompositeEntity container, java.lang.String name, java.lang.Object[] trainingSequence, double repetitionFactor, boolean pitch, boolean validate)	Constructs an OracleModel object.

Method Summary

Modifier and Type	Method	Description
protected FactorOracle	_createController(java.lang.Object[] trainingSequence, double repetitionFactor, boolean pitch, boolean validate)	Create a Factor Oracle controller.
void	setController(FactorOracle f)	Set the controller value.

Methods inherited from class ptolemy.domains.modal.modal.ModalRefinement

_checkContainer, _getRefinementClasses, addRefinement, addRefinement, dropObject, getRefinedState, newPort, setMirrorDisable

Methods inherited from class ptolemy.domains.modal.modal.ModalModel

attributeChanged, changeExecuted, changeFailed, clone, exportMoML, getAttribute, getCausalityInterface, getController, handleModelError, initialize

Methods inherited from class ptolemy.actor.TypedCompositeActor

_addEntity, _addPort, _addRelation, _checkTypesFromTo, _destinationTypeConstraints, attributeTypeChanged, isBackwardTypeInferenceEnabled, newRelation, resolveTypes, typeConstraintList, typeConstraints

Methods inherited from class ptolemy.actor.CompositeActor

_actorFiring, _actorFiring, _finishedAddEntity, _setDirector, _transferPortParameterInputs, addActorFiringListener, addInitializable, addPiggyback, connectionsChanged, createReceivers, createSchedule, fire, getDirector, getExecutiveDirector, getManager, getPublishedPort, getPublishedPortChannel, getPublishedPorts, getSubscribedPortChannel, inferringWidths, inferWidths, inputPortList, isFireFunctional, isOpaque, isPublishedPort, isStrict, iterate, linkToPublishedPort, linkToPublishedPort, linkToPublishedPort, linkToPublishedPort, needsWidthInference, newInsideReceiver, newReceiver, notifyConnectivityChange, outputPortList, postfire, prefire, preinitialize, recordFiring, registerPublisherPort, registerPublisherPort, removeActorFiringListener, removeInitializable, removePiggyback, requestChange, setContainer, setDirector, setManager, stop, stopFire, terminate, unlinkToPublishedPort, unlinkToPublishedPort, unlinkToPublishedPort, unlinkToPublishedPort, unregisterPublisherPort, unregisterPublisherPort, wrapup

Methods inherited from class ptolemy.kernel.CompositeEntity

_adjustDeferrals, _containedDecorators, _deepOpaqueEntityList, _description, _exportMoMLContents, _removeEntity, _removeRelation, _validateSettables, allAtomicEntityList, allowLevelCrossingConnect, classDefinitionList, connect, connect, containedObjectsIterator, deepCompositeEntityList, deepEntityList, deepGetEntities, deepNamedObjList, deepOpaqueEntityList, deepRelationSet, entityList, entityList, exportLinks, getEntities, getEntity, getPort, getRelation, getRelations, isAtomic, lazyAllAtomicEntityList, lazyAllCompositeEntityList, lazyAllCompositeTransparentAndOpaqueEntityList, lazyClassDefinitionList, lazyDeepEntityList, lazyEntityList, lazyRelationList, numberOfEntities, numberOfRelations, numEntities, numRelations, relationList, removeAllEntities, removeAllRelations, setClassDefinition, statistics, uniqueName

Methods inherited from class ptolemy.kernel.ComponentEntity

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

Methods inherited from class ptolemy.kernel.Entity

_removePort, connectedPortList, connectedPorts, getPorts, linkedRelationList, linkedRelations, portList, removeAllPorts

Methods inherited from class ptolemy.kernel.InstantiableNamedObj

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

Methods inherited from class ptolemy.kernel.util.NamedObj

_addAttribute, _adjustOverride, _attachText, _cloneFixAttributeFields, _copyChangeRequestList, _debug, _debug, _debug, _debug, _debug, _executeChangeRequests, _getIndentPrefix, _isMoMLSuppressed, _markContentsDerived, _notifyHierarchyListenersAfterChange, _notifyHierarchyListenersBeforeChange, _propagateValue, _removeAttribute, _splitName, _stripNumericSuffix, addChangeListener, addDebugListener, addHierarchyListener, attributeDeleted, attributeList, attributeList, clone, 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, isDeferringChangeRequests, isOverridden, isPersistent, lazyContainedObjectsIterator, message, notifyOfNameChange, propagateValue, propagateValues, removeAttribute, removeChangeListener, removeDebugListener, removeHierarchyListener, 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

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

Methods inherited from interface ptolemy.actor.TypedActor

isBackwardTypeInferenceEnabled, typeConstraints

Constructor Detail

OracleModel

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

Constructs an OracleModel object.

Parameters:

container - The Container

name - The name

Throws:

NameDuplicationException - If thrown by the parent class.

IllegalActionException - If thrown by the parent class.

OracleModel

public OracleModel(CompositeEntity container,
                   java.lang.String name,
                   java.lang.Object[] trainingSequence,
                   double repetitionFactor,
                   boolean pitch,
                   boolean validate)
            throws NameDuplicationException,
                   IllegalActionException

Constructs an OracleModel object.

Parameters:

container - The Container

name - The name

trainingSequence - training sequence of the factor oracle

repetitionFactor - a double indicating repetition factor on forward links

pitch - a boolean -- true if pitch oracle

validate - a boolean -- true if pitch validation is enabled

Throws:

NameDuplicationException - If thrown by the parent class.

IllegalActionException - If thrown by the parent class.

Method Detail

setController

public void setController(FactorOracle f)

Set the controller value.

Parameters:

f - The FactorOracle.

_createController

protected FactorOracle _createController(java.lang.Object[] trainingSequence,
                                         double repetitionFactor,
                                         boolean pitch,
                                         boolean validate)
                                  throws IllegalActionException,
                                         NameDuplicationException

Create a Factor Oracle controller.

Parameters:

trainingSequence - training sequence of the factor oracle

repetitionFactor - a double indicating repetition factor on forward links

pitch - a boolean -- true if pitch oracle

validate - a boolean -- true if pitch validation is enabled

Returns:

A Factor Oracle controller.

Throws:

IllegalActionException - If thrown while creating a FactorOracle.

NameDuplicationException - If thrown while creating a FactorOracle.