ptolemy.codegen.c.actor.lib.io
Class LineReader

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

All Implemented Interfaces:

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

public class LineReader
extends CCodeGeneratorHelper

A helper class for ptolemy.actor.lib.io.LineReader.

Since:

Ptolemy II 6.0

Version:

$Id: LineReader.java 46972 2007-10-02 17:16:38Z cxh $

Author:

Jackie

See Also:

Serialized Form

Accepted Rating:

Green (cxh)

Proposed Rating:

Green (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

private boolean

_fileOpen indicate whether or not the user requests to open a file e.g. false - write to standard (console) output true - some file name is specified

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

LineReader(LineReader actor)
Construct the LineReader helper.

Method Summary

java.lang.String	generateInitializeCode() Generate initialize code.
java.lang.String	generateWrapupCode() Generate wrap up code.
java.util.Set	getHeaderFiles() Get the files needed by the code generated for the LineReader actor.

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

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

Methods inherited from class ptolemy.codegen.kernel.CodeGeneratorHelper

_createBufferSizeAndOffsetMap, _createInputBufferSizeAndOffsetMap, _findClosedParen, _generateBlockCode, _generateBlockCode, _generateFireCode, _generateTypeConvertMethod, _generateTypeConvertStatements, _getCastType, _getChannelAndOffset, _getHelper, _getHelper, _getIndentPrefix, _getReference, _getReferenceChannels, _getTypeConvertChannels, _getTypeConvertReference, _indexOf, addFunctionUsed, addNewTypeUsed, analyzeTypeConvert, checkLocal, checkRemote, codeGenType, copyFilesToCodeDirectory, createOffsetVariablesIfNeeded, generateChannelOffset, generateFireCode, generateFireFunctionCode, generateFireFunctionCode2, generateModeTransitionCode, generateName, generateOffset, generatePortReference, generatePostfireCode, generatePrefireCode, generatePreinitializeCode, generateSimpleName, generateTypeConvertFireCode, generateTypeConvertFireCode, generateVariableInitialization, generateVariableName, getBufferSize, getBufferSize, getComponent, getDefaultBlocks, getDirector, getDirectorHelper, getFunctionInvocation, getIncludeDirectories, getLibraries, getLibraryDirectories, getModifiedVariables, getNewInvocation, getObject, getParameterValue, getPort, getRates, getReadOffset, getReference, getReference, getReference, getReference, getSharedCode, 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

Field Detail

_fileOpen

private boolean _fileOpen

indicate whether or not the user requests to open a file e.g. false - write to standard (console) output true - some file name is specified

Constructor Detail

LineReader

public LineReader(LineReader actor)

Construct the LineReader helper.

Parameters:

actor - the associated actor.

Method Detail

generateInitializeCode

public java.lang.String generateInitializeCode()
                                        throws IllegalActionException

Generate initialize code. This method reads the initBlock from LineReader.c, replaces macros with their values and returns the processed code string.

Specified by:

generateInitializeCode in interface ComponentCodeGenerator

Overrides:

generateInitializeCode in class CodeGeneratorHelper

Returns:

The processed initBlock.

Throws:

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

generateWrapupCode

public java.lang.String generateWrapupCode()
                                    throws IllegalActionException

Generate wrap up code. This method reads the wrapUpBlock from LineReader.c, replaces macros with their values and returns the processed code string.

Specified by:

generateWrapupCode in interface ComponentCodeGenerator

Overrides:

generateWrapupCode in class CodeGeneratorHelper

Returns:

The processed code string.

Throws:

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

getHeaderFiles

public java.util.Set getHeaderFiles()
                             throws IllegalActionException

Get the files needed by the code generated for the LineReader actor.

Specified by:

getHeaderFiles in interface ActorCodeGenerator

Overrides:

getHeaderFiles in class CCodeGeneratorHelper

Returns:

A set of strings that are names of the files needed by the code generated for the LineReader actor.

Throws:

IllegalActionException - Not Thrown in this subclass.