Package ptolemy.cg.adapter.generic.program.procedural.java.adapters.ptolemy.actor.lib.colt

Class ColtPoisson

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.java.adapters.ptolemy.actor.lib.colt.ColtRandomSource

ptolemy.cg.adapter.generic.program.procedural.java.adapters.ptolemy.actor.lib.colt.ColtPoisson

All Implemented Interfaces:

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

public class ColtPoisson
extends ColtRandomSource

An adapter class for ptolemy.actor.lib.colt.ColtPoisson. NOTE: Currently, random numbers produced by c code generated by this class differ from those produced by the ColtPoisson random generator.

Since:

Ptolemy II 10.0

Version:

$Id$

Author:

Christopher Brooks, based on codegen version by Teale Fristoe

See Also:

ColtPoisson

Pt.AcceptedRating:

Red (cxh)

Pt.ProposedRating:

Red (cxh)

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.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
ColtPoisson(ColtPoisson actor)	Constructor method for the ColtPoisson helper.

Method Summary

Modifier and Type	Method	Description
protected java.lang.String	_generateRandomNumber()	Generate code for producing a new random number.
java.lang.String	generateInitializeCode()	Generate the code for initializing the random number generator with the seed, if it has been given.
java.util.Set	getHeaderFiles()	Get the files needed by the code generated for the ColtPoisson actor.

Methods inherited from class ptolemy.cg.adapter.generic.program.procedural.java.adapters.ptolemy.actor.lib.colt.ColtRandomSource

_generateFireCode

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

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

ColtPoisson

public ColtPoisson(ColtPoisson actor)

Constructor method for the ColtPoisson helper.

Parameters:

actor - the associated actor

Method Detail

generateInitializeCode

public java.lang.String generateInitializeCode()
                                        throws IllegalActionException

Generate the code for initializing the random number generator with the seed, if it has been given. A seed of zero is interpreted to mean that no seed is specified. In such cases, a seed based on the current time and this instance of a ColtRandomSource is used to be fairly sure that two identical sequences will not be returned.

Overrides:

generateInitializeCode in class ColtRandomSource

Returns:

The initialize code of this actor.

Throws:

IllegalActionException - Not thrown in this class.

getHeaderFiles

public java.util.Set getHeaderFiles()
                             throws IllegalActionException

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

Overrides:

getHeaderFiles in class ColtRandomSource

Returns:

A set of Strings that are names of the files needed by the code generated for the ColtPoisson actor.

Throws:

IllegalActionException - Not Thrown in this subclass.

_generateRandomNumber

protected java.lang.String _generateRandomNumber()
                                          throws IllegalActionException

Generate code for producing a new random number.

Specified by:

_generateRandomNumber in class ColtRandomSource

Returns:

The code that produces a new random number.

Throws:

IllegalActionException - Not thrown in this base class.