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

Class FSMActor

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.program.procedural.adapters.ptolemy.domains.modal.kernel.FSMActor

ptolemy.cg.adapter.generic.program.procedural.c.adapters.ptolemy.domains.modal.kernel.FSMActor

All Implemented Interfaces:

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

public class FSMActor
extends FSMActor

Code generator adapter for FSMActor.

Since:

Ptolemy II 10.0

Version:

$Id$

Author:

William Lucas

Pt.AcceptedRating:

Red (cxh)

Pt.ProposedRating:

Red (cxh)

Nested Class Summary

Nested classes/interfaces inherited from class ptolemy.cg.adapter.generic.program.procedural.adapters.ptolemy.domains.modal.kernel.FSMActor

FSMActor.OutgoingRelations, FSMActor.PortScope, FSMActor.TransitionRetriever

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.program.procedural.adapters.ptolemy.domains.modal.kernel.FSMActor

_scope

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
FSMActor(FSMActor component)	Construct the code generator adapter associated with the given FSMActor.

Method Summary

Modifier and Type	Method	Description
protected java.lang.Object	_generateStateConstantLabel(State state)	Generate a label for a state constant.
java.lang.String	generateInitializeCode()	Generate the initialize code of the associated FSMActor.
java.lang.String	generatePreinitializeCode()	Generate the preinitialize code of the associated FSMActor.

Methods inherited from class ptolemy.cg.adapter.generic.program.procedural.adapters.ptolemy.domains.modal.kernel.FSMActor

_generateFireCode, _updateCurrentState, generateTransitionCode

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

_generateTypeConvertStatement, analyzeTypeConvert, copyFilesToCodeDirectory, generateFireCode, generateFireFunctionCode, generateMainLoop, generateModeTransitionCode, generatePostfireCode, generatePrefireCode, generatePreinitializeMethodBodyCode, generateSimpleName, generateTypeConvertFireCode, generateTypeConvertFireCode, generateVariableDeclaration, generateVariableInitialization, generateWrapupCode, getAddTimeString, getBufferSize, getBufferSize, getComponent, getDeclareSharedCode, getDefaultBlocks, getFireFunctionParameters, getHeaderFiles, getIncludeDirectories, getLibraries, getLibraryDirectories, getModifiedVariables, 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

FSMActor

public FSMActor(FSMActor component)
         throws NameDuplicationException,
                IllegalActionException

Construct the code generator adapter associated with the given FSMActor.

Parameters:

component - The associated component.

Throws:

IllegalActionException - If thrown by the parent class.

NameDuplicationException - If thrown by the parent class.

Method Detail

generateInitializeCode

public java.lang.String generateInitializeCode()
                                        throws IllegalActionException

Generate the initialize code of the associated FSMActor. It generates code for initializing current state with initial state, and initializing current configuration of the container when it applies (i.e., when this FSMActor works as a modal controller for a MultirateFSMDirector).

Overrides:

generateInitializeCode in class FSMActor

Returns:

The initialize code of the associated FSMActor.

Throws:

IllegalActionException - If initial state cannot be found, configuration number cannot be updated or code cannot be processed.

generatePreinitializeCode

public java.lang.String generatePreinitializeCode()
                                           throws IllegalActionException

Generate the preinitialize code of the associated FSMActor. It declares two variables for this actor: currentState and transitionFlag. currentState is an int representing this actor's current state. transitionFlag is an unsigned char to indicate if a preemptive transition is taken. It also defines a symbolic constant to each state.

Overrides:

generatePreinitializeCode in class FSMActor

Returns:

The preinitialize code of the associated FSMActor.

Throws:

IllegalActionException - If thrown when creating buffer size and offset map or processing code.

_generateStateConstantLabel

protected java.lang.Object _generateStateConstantLabel(State state)

Generate a label for a state constant.

Overrides:

_generateStateConstantLabel in class FSMActor

Parameters:

state - The state.

Returns:

The label.