Package ptolemy.cg.adapter.generic.program.procedural.adapters.ptolemy.domains.modal.kernel

Class FSMDirector

java.lang.Object

ptolemy.kernel.util.NamedObj

ptolemy.cg.kernel.generic.CodeGeneratorAdapter

ptolemy.cg.kernel.generic.program.ProgramCodeGeneratorAdapter

ptolemy.cg.kernel.generic.program.NamedProgramCodeGeneratorAdapter

ptolemy.cg.adapter.generic.adapters.ptolemy.actor.Director

ptolemy.cg.adapter.generic.program.procedural.adapters.ptolemy.domains.modal.kernel.FSMDirector

All Implemented Interfaces:

java.lang.Cloneable, Changeable, Debuggable, DebugListener, Derivable, ModelErrorHandler, MoMLExportable, Moveable, Nameable

Direct Known Subclasses:

FSMDirector, FSMDirector, FSMDirector

public class FSMDirector
extends Director

Code generator adapter associated with the FSMDirector class. This class is also associated with a code generator.

Since:

Ptolemy II 10.0

Version:

$Id$

Author:

Shanna-Shaye Forbes

Pt.AcceptedRating:

Red (sssf)

Pt.ProposedRating:

Red (sssf)

Nested Class Summary

Nested classes/interfaces inherited from class ptolemy.cg.kernel.generic.program.NamedProgramCodeGeneratorAdapter

NamedProgramCodeGeneratorAdapter.VariableScope

Nested classes/interfaces inherited from class ptolemy.cg.kernel.generic.program.ProgramCodeGeneratorAdapter

ProgramCodeGeneratorAdapter.Channel

Nested classes/interfaces inherited from class ptolemy.kernel.util.NamedObj

NamedObj.ContainedObjectsIterator

Field Summary

Fields inherited from class ptolemy.cg.adapter.generic.adapters.ptolemy.actor.Director

_director

Fields inherited from class ptolemy.cg.kernel.generic.program.ProgramCodeGeneratorAdapter

_component, _defaultBlocks, _eol, _templateParser

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

Constructor Summary

Constructors

Constructor	Description
FSMDirector(FSMDirector component)	Construct the code generator helper associated with the given modal controller.

Method Summary

Modifier and Type	Method	Description
java.lang.String	generateFireCode()	Generate the code for the firing of actors.
void	generateTransferInputsCode(IOPort inputPort, java.lang.StringBuffer code)	Generate code for transferring enough tokens to complete an internal iteration.
void	generateTransferOutputsCode(IOPort outputPort, java.lang.StringBuffer code)	Generate code for transferring enough tokens to fulfill the output production rate.
java.lang.String	getReference(java.lang.String name, boolean isWrite, NamedProgramCodeGeneratorAdapter target)	Return the reference to the specified parameter or port of the associated actor.

Methods inherited from class ptolemy.cg.adapter.generic.adapters.ptolemy.actor.Director

_ceilToPowerOfTwo, _generateVariableDeclaration, _generateVariableInitialization, _getParameter, generateCodeForGet, generateCodeForSend, generateConstructorCode, generateFireFunctionCode, generateInitializeCode, generateModeTransitionCode, generatePostfireCode, generatePreinitializeCode, generatePreinitializeMethodBodyCode, generateTransferInputsCode, generateTransferOutputsCode, generateVariableDeclaration, generateVariableDeclaration, generateVariableInitialization, generateVariableInitialization, generateWrapupCode, getComponent, getIncludeDirectories, getLibraries, getLibraryDirectories, getModifiedVariables, getParameter

Methods inherited from class ptolemy.cg.kernel.generic.program.NamedProgramCodeGeneratorAdapter

_generateFireCode, _generateTypeConvertStatement, analyzeTypeConvert, copyFilesToCodeDirectory, generateMainLoop, generatePrefireCode, generateSimpleName, generateTypeConvertFireCode, generateTypeConvertFireCode, getAddTimeString, getBufferSize, getBufferSize, getDeclareSharedCode, getDefaultBlocks, getFireFunctionParameters, getHeaderFiles, getName, getParameterValue, getReference, getReference, getSharedCode, getSinkChannels, getSourceTimeString, getTimeSourcePortName, getTypeConvertChannels, getTypeConvertReference, getTypeConvertSinkChannels, setupAdapter, targetType

Methods inherited from class ptolemy.cg.kernel.generic.program.ProgramCodeGeneratorAdapter

_generateBlockByName, getAdapter, getCodeGenerator, getTemplateParser, processCode, setCodeGenerator, setTemplateParser, toString

Methods inherited from class ptolemy.cg.kernel.generic.CodeGeneratorAdapter

createDecoratorAttributes, generateName

Methods inherited from class ptolemy.kernel.util.NamedObj

_addAttribute, _adjustOverride, _attachText, _cloneFixAttributeFields, _containedDecorators, _copyChangeRequestList, _debug, _debug, _debug, _debug, _debug, _description, _executeChangeRequests, _exportMoMLContents, _getContainedObject, _getIndentPrefix, _isMoMLSuppressed, _markContentsDerived, _notifyHierarchyListenersAfterChange, _notifyHierarchyListenersBeforeChange, _propagateExistence, _propagateValue, _removeAttribute, _splitName, _stripNumericSuffix, _validateSettables, addChangeListener, addDebugListener, addHierarchyListener, attributeChanged, attributeDeleted, attributeList, attributeList, attributeTypeChanged, clone, clone, containedObjectsIterator, decorators, deepContains, depthInHierarchy, description, description, event, executeChangeRequests, exportMoML, exportMoML, exportMoML, exportMoML, exportMoML, exportMoMLPlain, getAttribute, getAttribute, getAttributes, getChangeListeners, getClassName, getContainer, getDecoratorAttribute, getDecoratorAttributes, getDerivedLevel, getDerivedList, getDisplayName, getElementName, getFullName, getModelErrorHandler, getName, getPrototypeList, getSource, handleModelError, isDeferringChangeRequests, isOverridden, isPersistent, lazyContainedObjectsIterator, message, moveDown, moveToFirst, moveToIndex, moveToLast, moveUp, notifyOfNameChange, propagateExistence, propagateValue, propagateValues, removeAttribute, removeChangeListener, removeDebugListener, removeHierarchyListener, requestChange, setClassName, setDeferringChangeRequests, setDerivedLevel, setDisplayName, setModelErrorHandler, setName, setPersistent, setSource, sortContainedObjects, toplevel, uniqueName, validateSettables, workspace

Methods inherited from class java.lang.Object

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

Constructor Detail

FSMDirector

public FSMDirector(FSMDirector component)

Construct the code generator helper associated with the given modal controller.

Parameters:

component - The associated component.

Method Detail

generateFireCode

public java.lang.String generateFireCode()
                                  throws IllegalActionException

Generate the code for the firing of actors. In this base class, it is attempted to fire all the actors once. In subclasses such as the adapters for SDF and Giotto directors, the firings of actors observe the associated schedule. In addition, some special handling is needed, e.g., the iteration limit in SDF and time advancement in Giotto.

Overrides:

generateFireCode in class Director

Returns:

The generated code.

Throws:

IllegalActionException - If the adapter associated with an actor throws it while generating fire code for the actor.

generateTransferInputsCode

public void generateTransferInputsCode(IOPort inputPort,
                                       java.lang.StringBuffer code)
                                throws IllegalActionException

Generate code for transferring enough tokens to complete an internal iteration.

Overrides:

generateTransferInputsCode in class Director

Parameters:

inputPort - The port to transfer tokens.

code - The string buffer that the generated code is appended to.

Throws:

IllegalActionException - If thrown while transferring tokens.

generateTransferOutputsCode

public void generateTransferOutputsCode(IOPort outputPort,
                                        java.lang.StringBuffer code)
                                 throws IllegalActionException

Generate code for transferring enough tokens to fulfill the output production rate.

Overrides:

generateTransferOutputsCode in class Director

Parameters:

outputPort - The port to transfer tokens.

code - The string buffer that the generated code is appended to.

Throws:

IllegalActionException - If thrown while transferring tokens.

getReference

public java.lang.String getReference(java.lang.String name,
                                     boolean isWrite,
                                     NamedProgramCodeGeneratorAdapter target)
                              throws IllegalActionException

Return the reference to the specified parameter or port of the associated actor. For a parameter, the returned string is in the form "fullName_parameterName". For a port, the returned string is in the form "fullName_portName[channelNumber][offset]", if any channel number or offset is given.

Overrides:

getReference in class Director

Parameters:

name - The name of the parameter or port

isWrite - Whether to generate the write or read offset.

target - The ProgramCodeGeneratorAdapter for which code needs to be generated.

Returns:

The reference to that parameter or port (a variable name, for example).

Throws:

IllegalActionException - If the parameter or port does not exist or does not have a value.