ptolemy.codegen.c.actor.lib
Class Publisher

java.lang.Object
  ptolemy.kernel.util.NamedObj
      ptolemy.codegen.kernel.CodeGeneratorHelper
          ptolemy.codegen.c.kernel.CCodeGeneratorHelper
              ptolemy.codegen.c.actor.lib.Publisher

All Implemented Interfaces:

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

public class Publisher
extends CCodeGeneratorHelper

Generate C code for an actor that publishes tokens on a named channel.

Since:

Ptolemy II 6.1

Version:

$Id: Publisher.java,v 1.6 2007/12/06 21:56:12 cxh Exp $

Author:

Christopher Brooks

See Also:

Publisher, Serialized Form

Accepted Rating:

Red (cxh)

Proposed Rating:

Red (mankit)

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.kernel.CodeGeneratorHelper

_bufferSizes, _codeGenerator, _codeStream, _eol, _INDENT1, _INDENT2, _parseTreeCodeGenerator, _portConversions, _readOffsets, _referencedParameters, _writeOffsets

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

Publisher(Publisher actor)
Constructor method for the Publisher helper.

Method Summary

java.lang.String

generateFireCode() Generate fire code.

Methods inherited from class ptolemy.codegen.c.kernel.CCodeGeneratorHelper

_generateInputVariableDeclaration, _generateOutputVariableDeclaration, _generateReferencedParameterDeclaration, _generateTypeConvertVariableDeclaration, _replaceMacro, generateVariableDeclaration, getCodeGenerator, getJVMHeaderFiles, getParseTreeCodeGenerator

Methods inherited from class ptolemy.codegen.kernel.CodeGeneratorHelper

_createBufferSizeAndOffsetMap, _createInputBufferSizeAndOffsetMap, _generateBlockByName, _generateBlockCode, _generateBlockCode, _generateTypeConvertMethod, _generateTypeConvertStatement, _generateTypeConvertStatements, _getChannelAndOffset, _getHelper, _getIndentPrefix, _getTypeConvertChannels, _getTypeConvertReference, addNewTypeUsed, analyzeTypeConvert, codeGenType, copyFilesToCodeDirectory, createOffsetVariablesIfNeeded, generateChannelOffset, generateFireFunctionCode, generateInitializeCode, generateModeTransitionCode, generateName, generateOffset, generatePostfireCode, generatePreinitializeCode, generateTypeConvertFireCode, generateTypeConvertFireCode, generateVariableInitialization, generateVariableName, generateWrapupCode, getBufferSize, getBufferSize, getComponent, getDefaultBlocks, getFunctionInvocation, getHeaderFiles, getIncludeDirectories, getLibraries, getLibraryDirectories, getModifiedVariables, getNewInvocation, getParameterValue, getPort, getRates, getReadOffset, getReference, getReference, getSharedCode, getSinkChannels, getSize, getSourceChannel, getWriteOffset, isPrimitive, isPrimitive, processCode, ptolemyType, resetInputPortsOffset, setBufferSize, setCodeGenerator, setReadOffset, setWriteOffset, targetType

Methods inherited from class ptolemy.kernel.util.NamedObj

_addAttribute, _adjustOverride, _attachText, _cloneFixAttributeFields, _debug, _debug, _debug, _debug, _debug, _description, _exportMoMLContents, _getContainedObject, _isMoMLSuppressed, _markContentsDerived, _propagateExistence, _propagateValue, _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, getDerivedLevel, getDerivedList, getDisplayName, getElementName, getFullName, getModelErrorHandler, getName, getName, getPrototypeList, getSource, handleModelError, isDeferringChangeRequests, isOverridden, isPersistent, message, moveDown, moveToFirst, moveToIndex, moveToLast, moveUp, propagateExistence, propagateValue, propagateValues, removeChangeListener, removeDebugListener, requestChange, setClassName, setDeferringChangeRequests, setDerivedLevel, setDisplayName, setModelErrorHandler, setName, setPersistent, setSource, sortContainedObjects, toplevel, toString, uniqueName, validateSettables, workspace

Methods inherited from class java.lang.Object

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

Constructor Detail

Publisher

public Publisher(Publisher actor)

Constructor method for the Publisher helper.

Parameters:

actor - the associated actor

Method Detail

generateFireCode

public java.lang.String generateFireCode()
                                  throws IllegalActionException

Generate fire code. The method reads in fireBlock from Publisher.c and replaces macros with their values and returns the processed code block.

Specified by:

generateFireCode in interface ActorCodeGenerator

Overrides:

generateFireCode in class CodeGeneratorHelper

Returns:

The generated code.

Throws:

IllegalActionException - If the code stream encounters an error in processing the specified code block(s).