ptolemy.codegen.rtmaude.actor
Class TypedCompositeActor

java.lang.Object
  ptolemy.kernel.util.NamedObj
      ptolemy.codegen.kernel.CodeGeneratorHelper
          ptolemy.codegen.rtmaude.kernel.RTMaudeAdaptor
              ptolemy.codegen.rtmaude.kernel.Entity
                  ptolemy.codegen.rtmaude.actor.TypedCompositeActor

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, ActorCodeGenerator, ComponentCodeGenerator, Changeable, Debuggable, DebugListener, Derivable, ModelErrorHandler, MoMLExportable, Moveable, Nameable

Direct Known Subclasses:

ModalModel

public class TypedCompositeActor
extends Entity

Generate RTMaude code for a typed composite actor.

Since:

Ptolemy II 8.0

Version:

$Id: TypedCompositeActor.java 59167 2010-09-21 17:08:02Z cxh $

Author:

Kyungmin Bae

See Also:

TypedCompositeActor, Serialized Form

Accepted Rating:

red (kquine)

Proposed Rating:

red (kquine)

Nested Class Summary

Nested classes/interfaces inherited from class ptolemy.codegen.kernel.CodeGeneratorHelper

CodeGeneratorHelper.Channel, CodeGeneratorHelper.VariableScope

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

NamedObj.ContainedObjectsIterator

Field Summary

Fields inherited from class ptolemy.codegen.rtmaude.kernel.RTMaudeAdaptor

defaultTermBlock

Fields inherited from class ptolemy.codegen.kernel.CodeGeneratorHelper

_codeGenerator, _codeStream, _eol, _INDENT1, _INDENT2, _parseTreeCodeGenerator, _portConversions, _referencedParameters

Fields inherited from class ptolemy.kernel.util.NamedObj

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

Constructor Summary

TypedCompositeActor(TypedCompositeActor component)
Construct the code generator helper associated with the given TypedCompositeActor.

Method Summary

java.lang.String	generateFireFunctionCode() Generate The fire function code.
java.util.List<java.lang.String>	getBlockCodeList(java.lang.String blockName, java.lang.String... args) Given a block name, generate a list of codes for that block.
protected java.lang.String	getInfo(java.lang.String name, java.util.List<java.lang.String> parameters) Returns some information of the component.
java.util.List<java.lang.String>	getModuleCode(java.lang.String header) Generates code for RTMaude module with the given template indicated by the header of the block.

Methods inherited from class ptolemy.codegen.rtmaude.kernel.Entity

_generateFireCode

Methods inherited from class ptolemy.codegen.rtmaude.kernel.RTMaudeAdaptor

_generateBlockCode, _generateTypeConvertMethod, _replaceMacro, generateEntryCode, generateExitCode, generateFireCode, generateTermCode, getParseTreeCodeGenerator, getRTMmodule, getSharedCode, getTranslatedExpression

Methods inherited from class ptolemy.codegen.kernel.CodeGeneratorHelper

_createBufferSizeAndOffsetMap, _createInputBufferSizeAndOffsetMap, _findClosedParen, _generateBlockCode, _generateBlockCode, _generateTypeConvertStatement, _generateTypeConvertStatements, _getCastType, _getChannelAndOffset, _getFireFunctionArguments, _getHelper, _getHelper, _getIndentPrefix, _getReference, _getReferenceChannels, _getTypeConvertChannels, _getTypeConvertReference, _indexOf, addFunctionUsed, addNewTypeUsed, analyzeTypeConvert, checkLocal, checkRemote, codeGenType, copyFilesToCodeDirectory, createOffsetVariablesIfNeeded, generateChannelOffset, generateFireFunctionCode2, generateInitializeCode, generateModeTransitionCode, generateName, generateOffset, generatePortReference, generatePostfireCode, generatePrefireCode, generatePreinitializeCode, generateSimpleName, generateTypeConvertFireCode, generateTypeConvertFireCode, generateVariableDeclaration, generateVariableInitialization, generateVariableName, generateWrapupCode, getBufferSize, getBufferSize, getCodeGenerator, getComponent, getDefaultBlocks, getDirector, getDirectorHelper, getFunctionInvocation, getHeaderFiles, getIncludeDirectories, getLibraries, getLibraryDirectories, getModifiedVariables, getNewInvocation, getObject, getParameterValue, getPort, getRates, getReadOffset, getReference, getReference, getReference, getReference, getSinkChannels, getSize, getSourceChannel, getWCET, getWriteOffset, isPrimitive, isPrimitive, parseList, processCode, resetInputPortsOffset, setBufferSize, setCodeGenerator, setReadOffset, setWriteOffset, targetType, toString

Methods inherited from class ptolemy.kernel.util.NamedObj

_addAttribute, _adjustOverride, _attachText, _cloneFixAttributeFields, _debug, _debug, _debug, _debug, _debug, _description, _exportMoMLContents, _getContainedObject, _isMoMLSuppressed, _markContentsDerived, _propagateExistence, _propagateValue, _recordDecoratedAttributes, _removeAttribute, _splitName, _stripNumericSuffix, _validateSettables, addChangeListener, addDebugListener, attributeChanged, attributeList, attributeList, attributeTypeChanged, clone, clone, containedObjectsIterator, 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, getName, getPrototypeList, getSource, handleModelError, isDeferringChangeRequests, isOverridden, isPersistent, lazyContainedObjectsIterator, message, moveDown, moveToFirst, moveToIndex, moveToLast, moveUp, propagateExistence, propagateValue, propagateValues, removeChangeListener, removeDebugListener, 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

TypedCompositeActor

public TypedCompositeActor(TypedCompositeActor component)

Construct the code generator helper associated with the given TypedCompositeActor.

Parameters:

component - The associated TypedCompositeActor.

Method Detail

getBlockCodeList

public java.util.List<java.lang.String> getBlockCodeList(java.lang.String blockName,
                                                         java.lang.String... args)
                                                  throws IllegalActionException

Description copied from class: RTMaudeAdaptor

Given a block name, generate a list of codes for that block. (For Composite Actor and Director)

Overrides:

getBlockCodeList in class RTMaudeAdaptor

Parameters:

blockName - The name of the block.

args - The arguments for the block.

Returns:

The list of the block codes

Throws:

IllegalActionException

generateFireFunctionCode

public java.lang.String generateFireFunctionCode()
                                          throws IllegalActionException

Description copied from class: CodeGeneratorHelper

Generate The fire function code. This method is called when the firing code of each actor is not inlined. Each actor's firing code is in a function with the same name as that of the actor.

Specified by:

generateFireFunctionCode in interface ActorCodeGenerator

Overrides:

generateFireFunctionCode in class RTMaudeAdaptor

Returns:

The fire function code.

Throws:

IllegalActionException - If thrown while generating fire code.

getModuleCode

public java.util.List<java.lang.String> getModuleCode(java.lang.String header)
                                               throws IllegalActionException

Description copied from class: RTMaudeAdaptor

Generates code for RTMaude module with the given template indicated by the header of the block. The name of the template block will be "header_Class".

Overrides:

getModuleCode in class RTMaudeAdaptor

Parameters:

header - The header of the template block

Returns:

The RTMaude module code

Throws:

IllegalActionException

getInfo

protected java.lang.String getInfo(java.lang.String name,
                                   java.util.List<java.lang.String> parameters)
                            throws IllegalActionException

Description copied from class: RTMaudeAdaptor

Returns some information of the component. Subclasses may override this method to define more specific information.

Overrides:

getInfo in class Entity

Parameters:

name - The name of the desired information

parameters - The parameters for the information

Returns:

The information indicated by the given name.

Throws:

IllegalActionException