/* Code generator helper class associated with the Director class.
Copyright (c) 2005-2009 The Regents of the University of California.
All rights reserved.
Permission is hereby granted, without written agreement and without
license or royalty fees, to use, copy, modify, and distribute this
software and its documentation for any purpose, provided that the above
copyright notice and the following two paragraphs appear in all copies
of this software.
IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.
THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
CALIFORNIA HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,
ENHANCEMENTS, OR MODIFICATIONS.
PT_COPYRIGHT_VERSION_2
COPYRIGHTENDKEY
*/
package ptolemy.codegen.actor;
import java.util.HashSet;
import java.util.Iterator;
import java.util.LinkedList;
import java.util.List;
import java.util.Set;
import ptolemy.actor.Actor;
import ptolemy.actor.CompositeActor;
import ptolemy.actor.IOPort;
import ptolemy.actor.TypedCompositeActor;
import ptolemy.actor.TypedIOPort;
import ptolemy.actor.util.DFUtilities;
import ptolemy.actor.util.ExplicitChangeContext;
import ptolemy.codegen.kernel.CodeGenerator;
import ptolemy.codegen.kernel.CodeGeneratorHelper;
import ptolemy.codegen.kernel.CodeStream;
import ptolemy.codegen.kernel.ComponentCodeGenerator;
import ptolemy.codegen.kernel.PortCodeGenerator;
import ptolemy.data.DoubleToken;
import ptolemy.data.IntToken;
import ptolemy.data.expr.Variable;
import ptolemy.kernel.Entity;
import ptolemy.kernel.util.Attribute;
import ptolemy.kernel.util.IllegalActionException;
import ptolemy.kernel.util.NamedObj;
import ptolemy.util.StringUtilities;
////Director
/**
Code generator helper associated with the ptolemy.actor.Director class.
This class is also associated with a code generator.
FIXME: need documentation on how subclasses should extend this class.
@see CodeGenerator
@author Ye Zhou, Gang Zhou
@version $Id$
@since Ptolemy II 7.1
@Pt.ProposedRating Yellow (zhouye)
@Pt.AcceptedRating Yellow (zhouye)
*/
public class Director extends CodeGeneratorHelper {
/** Construct the code generator helper associated with the given director.
* Note before calling the generate*() methods, you must also call
* setCodeGenerator(CodeGenerator).
* @param director The associated director.
*/
public Director(ptolemy.actor.Director director) {
_director = director;
}
/////////////////////////////////////////////////////////////////
//// public methods ////
/** Generate code for declaring read and write offset variables if needed.
* It delegates to the helpers of contained actors.
* @return The generated code.
* @exception IllegalActionException If thrown while creating
* offset variables.
*/
public String createOffsetVariablesIfNeeded() throws IllegalActionException {
StringBuffer code = new StringBuffer();
Iterator actors = ((CompositeActor) _director.getContainer())
.deepEntityList().iterator();
while (actors.hasNext()) {
Actor actor = (Actor) actors.next();
CodeGeneratorHelper helperObject = (CodeGeneratorHelper) _getHelper((NamedObj) actor);
code.append(helperObject.createOffsetVariablesIfNeeded());
}
return code.toString();
}
/**
* Generate the code for sending data to the specified port channel.
* This returns an empty string. Subclasses may override this method
* to generate domain-specific code for sending data.
* @param port The specified port.
* @param channel The specified channel.
* @param dataToken The data to send.
* @return An empty string in this base class.
* @exception IllegalActionException Not thrown in this base class.
*/
public String generateCodeForSend(IOPort port, int channel, String dataToken)
throws IllegalActionException {
return "";
}
/**
* Generate the code for getting data from the specified port channel.
* This returns an empty string. Subclasses may override this method
* to generate domain-specific code for getting data.
* @param port The specified port.
* @param channel The specified channel.
* @return An empty string in this base class.
* @exception IllegalActionException Not thrown in this base class.
*/
public String generateCodeForGet(IOPort port, int channel)
throws IllegalActionException {
return "";
}
/** Generate the code for the firing of actors.
* In this base class, it is attempted to fire all the actors once.
* In subclasses such as the helpers for SDF and Giotto directors, the
* firings of actors observe the associated schedule. In addition,
* some special handling is needed, e.g., the iteration limit in SDF
* and time advancement in Giotto.
* @return The generated code.
* @exception IllegalActionException If the helper associated with
* an actor throws it while generating fire code for the actor.
*/
public String generateFireCode() throws IllegalActionException {
StringBuffer code = new StringBuffer();
code.append(_codeGenerator.comment("The firing of the director."));
Iterator actors = ((CompositeActor) _director.getContainer())
.deepEntityList().iterator();
while (actors.hasNext()) {
Actor actor = (Actor) actors.next();
CodeGeneratorHelper helper = (CodeGeneratorHelper) _getHelper((NamedObj) actor);
code.append(helper.generateFireCode());
}
return code.toString();
}
/** 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.
*
* @return The fire function code.
* @exception IllegalActionException If thrown while generating fire code.
*/
public String generateFireFunctionCode() throws IllegalActionException {
StringBuffer code = new StringBuffer();
Iterator actors = ((CompositeActor) _director.getContainer())
.deepEntityList().iterator();
while (actors.hasNext()) {
Actor actor = (Actor) actors.next();
CodeGeneratorHelper actorHelper = (CodeGeneratorHelper) _getHelper((NamedObj) actor);
code.append(actorHelper.generateFireFunctionCode());
}
return code.toString();
}
/** Get the files needed by the code generated from this helper class.
* This base class returns an empty set.
* @return A set of strings that are header files needed by the code
* generated from this helper class.
* @exception IllegalActionException If something goes wrong.
*/
public Set getHeaderFiles() throws IllegalActionException {
return new HashSet();
}
/** Generate a main loop for an execution under the control of
* this director. In this base class, this simply delegates
* to generateFireCode() and generatePostfireCOde().
* @return Whatever generateFireCode() returns.
* @exception IllegalActionException Not thrown in this base class.
*/
public String generateMainLoop() throws IllegalActionException {
return generatePrefireCode() + generateFireCode()
+ generatePostfireCode();
}
/** Generate the initialize code for this director.
* The initialize code for the director is generated by appending the
* initialize code for each actor.
* @return The generated initialize code.
* @exception IllegalActionException If the helper associated with
* an actor throws it while generating initialize code for the actor.
*/
public String generateInitializeCode() throws IllegalActionException {
StringBuffer code = new StringBuffer();
code.append(_codeGenerator.comment(1,
"The initialization of the director."));
Iterator actors = ((CompositeActor) _director.getContainer())
.deepEntityList().iterator();
while (actors.hasNext()) {
Actor actor = (Actor) actors.next();
CodeGeneratorHelper helperObject = (CodeGeneratorHelper) _getHelper((NamedObj) actor);
// Initialize code for the actor.
code.append(helperObject.generateInitializeCode());
// Update write offset due to initial tokens produced.
Iterator outputPorts = actor.outputPortList().iterator();
while (outputPorts.hasNext()) {
IOPort port = (IOPort) outputPorts.next();
int rate = DFUtilities.getTokenInitProduction(port);
_updateConnectedPortsOffset(port, code, rate);
}
for (IOPort port : (List<IOPort>) ((Entity) actor).portList()) {
if (port.isOutsideConnected()) {
CodeGeneratorHelper portHelper = (CodeGeneratorHelper) _getHelper(port);
code.append(portHelper.generateInitializeCode());
}
}
}
return code.toString();
}
/**
* Generate the expression that represents the offset in the generated
* code.
* @param offsetString The specified offset from the user.
* @param port The referenced port.
* @param channel The referenced port channel.
* @param isWrite Whether to generate the write or read offset.
* @param helper The specified helper.
* @return The expression that represents the offset in the generated
* code.
* @exception IllegalActionException If there is problems getting
* the port buffer size or the offset in the channel and offset map.
*/
public String generateOffset(String offsetString, IOPort port, int channel,
boolean isWrite, CodeGeneratorHelper helper)
throws IllegalActionException {
assert false;
return "";
//return helper._generateOffset(offsetString, port, channel, isWrite);
}
/** Generate the postfire code of the associated composite actor.
*
* @return The postfire code of the associated composite actor.
* @exception IllegalActionException If the helper associated with
* an actor throws it while generating postfire code for the actor
* or while creating buffer size and offset map.
*/
public String generatePostfireCode() throws IllegalActionException {
StringBuffer code = new StringBuffer();
code.append(_codeGenerator.comment(0, "The postfire of the director."));
Iterator actors = ((CompositeActor) _director.getContainer())
.deepEntityList().iterator();
while (actors.hasNext()) {
Actor actor = (Actor) actors.next();
CodeGeneratorHelper helperObject = (CodeGeneratorHelper) _getHelper((NamedObj) actor);
code.append(helperObject.generatePostfireCode());
}
return code.toString();
}
/** Generate the preinitialize code for this director.
* The preinitialize code for the director is generated by appending
* the preinitialize code for each actor.
* @return The generated preinitialize code.
* @exception IllegalActionException If getting the helper fails,
* or if generating the preinitialize code for a helper fails,
* or if there is a problem getting the buffer size of a port.
*/
public String generatePreinitializeCode() throws IllegalActionException {
StringBuffer code = new StringBuffer();
Iterator actors = ((CompositeActor) _director.getContainer())
.deepEntityList().iterator();
boolean addedDirectorComment = false;
while (actors.hasNext()) {
Actor actor = (Actor) actors.next();
CodeGeneratorHelper helperObject = (CodeGeneratorHelper) _getHelper((NamedObj) actor);
// If a helper generates preinitialization code, then
// print a comment
String helperObjectPreinitializationCode = helperObject
.generatePreinitializeCode();
if (!addedDirectorComment
&& CodeGenerator
.containsCode(helperObjectPreinitializationCode)) {
addedDirectorComment = true;
code.append(_codeGenerator.comment(0,
"The preinitialization of the director."));
}
code.append(helperObjectPreinitializationCode);
}
return code.toString();
}
/** Generate mode transition code. It delegates to the helpers of
* actors under the control of this director. The mode transition
* code generated in this method is executed after each global
* iteration, e.g., in HDF model.
*
* @param code The string buffer that the generated code is appended to.
* @exception IllegalActionException If an actor helper throws it
* while generating mode transition code.
*/
public void generateModeTransitionCode(StringBuffer code)
throws IllegalActionException {
Iterator actors = ((CompositeActor) _director.getContainer())
.deepEntityList().iterator();
while (actors.hasNext()) {
Actor actor = (Actor) actors.next();
CodeGeneratorHelper helperObject = (CodeGeneratorHelper) _getHelper((NamedObj) actor);
helperObject.generateModeTransitionCode(code);
}
}
/** Generate code for transferring enough tokens to complete an internal
* iteration.
* @param inputPort The port to transfer tokens.
* @param code The string buffer that the generated code is appended to.
* @exception IllegalActionException If thrown while transferring tokens.
*/
public void generateTransferInputsCode(IOPort inputPort, StringBuffer code)
throws IllegalActionException {
code.append(CodeStream.indent(_codeGenerator
.comment("Transfer tokens to the inside")));
CodeGeneratorHelper _compositeActorHelper = (CodeGeneratorHelper) _getHelper(_director
.getContainer());
for (int i = 0; i < inputPort.getWidth(); i++) {
if (i < inputPort.getWidthInside()) {
String name = inputPort.getName();
if (inputPort.isMultiport()) {
name = name + '#' + i;
}
code.append(CodeStream.indent(_compositeActorHelper
.getReference("@" + name)));
code.append(" = ");
code.append(_compositeActorHelper.getReference(name));
code.append(";" + _eol);
}
}
// Generate the type conversion code before fire code.
code.append(_compositeActorHelper.generateTypeConvertFireCode(true));
// The offset of the input port itself is updated by outside director.
_updateConnectedPortsOffset(inputPort, code, 1);
}
/** Generate code for transferring enough tokens to fulfill the output
* production rate.
* @param outputPort The port to transfer tokens.
* @param code The string buffer that the generated code is appended to.
* @exception IllegalActionException If thrown while transferring tokens.
*/
public void generateTransferOutputsCode(IOPort outputPort, StringBuffer code)
throws IllegalActionException {
code.append(_codeGenerator.comment("Transfer tokens to the outside"));
CodeGeneratorHelper _compositeActorHelper = (CodeGeneratorHelper) _getHelper(_director
.getContainer());
for (int i = 0; i < outputPort.getWidthInside(); i++) {
if (i < outputPort.getWidth()) {
String name = outputPort.getName();
if (outputPort.isMultiport()) {
name = name + '#' + i;
}
code.append(_compositeActorHelper.getReference(name) + " = ");
code.append(_compositeActorHelper.getReference("@" + name));
code.append(";" + _eol);
}
}
// The offset of the ports connected to the output port is
// updated by outside director.
_updatePortOffset(outputPort, code, 1);
}
/** Generate variable declarations for inputs and outputs and parameters.
* Append the declarations to the given string buffer.
* @return code The generated code.
* @exception IllegalActionException If the helper class for the model
* director cannot be found.
*/
public String generateVariableDeclaration() throws IllegalActionException {
StringBuffer code = new StringBuffer();
Iterator actors = ((CompositeActor) _director.getContainer())
.deepEntityList().iterator();
while (actors.hasNext()) {
Actor actor = (Actor) actors.next();
CodeGeneratorHelper helperObject = (CodeGeneratorHelper) _getHelper((NamedObj) actor);
code.append(helperObject.generateVariableDeclaration());
}
return code.toString();
}
/** Generate variable initialization for the referenced parameters.
* @return code The generated code.
* @exception IllegalActionException If the helper class for the model
* director cannot be found.
*/
public String generateVariableInitialization()
throws IllegalActionException {
StringBuffer code = new StringBuffer();
Iterator actors = ((CompositeActor) _director.getContainer())
.deepEntityList().iterator();
while (actors.hasNext()) {
Actor actor = (Actor) actors.next();
CodeGeneratorHelper helperObject = (CodeGeneratorHelper) _getHelper((NamedObj) actor);
code.append(helperObject.generateVariableInitialization());
}
return code.toString();
}
/** Generate the wrapup code of the director associated with this helper
* class. For this base class, this method just generate the wrapup code
* for each actor.
* @return The generated wrapup code.
* @exception IllegalActionException If the helper class for each actor
* cannot be found, or if an error occurs while the helper generate the
* wrapup code.
*/
public String generateWrapupCode() throws IllegalActionException {
StringBuffer code = new StringBuffer();
code.append(_codeGenerator.comment(1, "The wrapup of the director."));
Iterator actors = ((CompositeActor) _director.getContainer())
.deepEntityList().iterator();
while (actors.hasNext()) {
Actor actor = (Actor) actors.next();
ComponentCodeGenerator helperObject = _getHelper((NamedObj) actor);
code.append(helperObject.generateWrapupCode());
}
return code.toString();
}
/**
* Return an unique label for the given port channel referenced
* by the given helper. By default, this delegates to the helper to
* generate the reference. Subclass may override this method
* to generate the desire label according to the given parameters.
* @param port The given port.
* @param channelAndOffset The given channel and offset.
* @param forComposite Whether the given helper is associated with
* a CompositeActor
* @param isWrite The type of the reference. True if this is
* a write reference; otherwise, this is a read reference.
* @param helper The specified helper.
* @return an unique reference label for the given port channel.
* @exception IllegalActionException If the helper throws it while
* generating the label.
*/
public String getReference(TypedIOPort port, String[] channelAndOffset,
boolean forComposite, boolean isWrite, CodeGeneratorHelper helper)
throws IllegalActionException {
return helper.getReference(port, channelAndOffset, forComposite,
isWrite);
}
/**
* Return an unique label for the given attribute referenced
* by the given helper. By default, this delegates to the helper to
* generate the reference. Subclass may override this method
* to generate the desire label according to the given parameters.
* @param attribute The given attribute.
* @param channelAndOffset The given channel and offset.
* @param helper The specified helper.
* @return an unique label for the given attribute.
* @exception IllegalActionException If the helper throws it while
* generating the label.
*/
public String getReference(Attribute attribute, String[] channelAndOffset,
CodeGeneratorHelper helper) throws IllegalActionException {
return helper.getReference(attribute, channelAndOffset);
}
/**
* Return the reference channels for the specified port channel.
* If the port channel is input or contained by an opaque CompositeActor,
* then this will return a list containing the given port channel.
* Otherwise, it returns a list of the connected sink channels.
* @param port The given port.
* @param channelNumber The given channel.
* @return The list of reference channels.
* @exception IllegalActionException If {@link #getSinkChannels(IOPort, int)}
* throws it.
*/
public static List<Channel> getReferenceChannels(IOPort port,
int channelNumber) throws IllegalActionException {
boolean forComposite = false;
// To support modal model, we need to check the following condition
// first because an output port of a modal controller should be
// mainly treated as an output port. However, during choice action,
// an output port of a modal controller will receive the tokens sent
// from the same port. During commit action, an output port of a modal
// controller will NOT receive the tokens sent from the same port.
if ((port.isOutput() && !forComposite)
|| (port.isInput() && forComposite)) {
List sinkChannels = CodeGeneratorHelper.getSinkChannels(port,
channelNumber);
return sinkChannels;
}
List<Channel> result = new LinkedList<Channel>();
if ((port.isInput() && !forComposite && port.isOutsideConnected())
|| (port.isOutput() && forComposite)) {
result.add(new Channel(port, channelNumber));
}
return result;
}
/** Return the buffer size of a given channel (i.e, a given port
* and a given channel number). In this base class, this method
* always returns 1.
* @param port The given port.
* @param channelNumber The given channel number.
* @return The buffer size of the given channel. This base class
* always returns 1.
* @exception IllegalActionException Not thrown in this base class.
*/
public int getBufferSize(IOPort port, int channelNumber)
throws IllegalActionException {
return 1;
}
/** Return the director associated with this class.
* @return The director associated with this class.
*/
public NamedObj getComponent() {
return _director;
}
/** Return an empty HashSet.
* @return An empty HashSet.
* @exception IllegalActionException Not thrown in this method.
*/
public Set getIncludeDirectories() throws IllegalActionException {
return new HashSet();
}
/** Return an empty HashSet.
* @return An empty HashSet.
* @exception IllegalActionException Not thrown in this method.
*/
public Set getLibraries() throws IllegalActionException {
return new HashSet();
}
/** Return an empty HashSet.
* @return An empty HashSet.
* @exception IllegalActionException Not thrown in this method.
*/
public Set getLibraryDirectories() throws IllegalActionException {
return new HashSet();
}
/** Return a set of parameters that will be modified during the execution
* of the model. The director gets those variables if it implements
* ExplicitChangeContext interface.
*
* @return a set of parameters that will be modified.
* @exception IllegalActionException If the helper associated with an actor
* or director throws it while getting modified variables.
*/
public Set getModifiedVariables() throws IllegalActionException {
Set set = new HashSet();
if (_director instanceof ExplicitChangeContext) {
set.addAll(((ExplicitChangeContext) _director)
.getModifiedVariables());
}
Iterator actors = ((CompositeActor) _director.getContainer())
.deepEntityList().iterator();
while (actors.hasNext()) {
Actor actor = (Actor) actors.next();
CodeGeneratorHelper helperObject = (CodeGeneratorHelper) _getHelper((NamedObj) actor);
set.addAll(helperObject.getModifiedVariables());
}
return set;
}
/**
* Return the worst case execution time (WCET) seen by this
* director.
* @return The Worst Case Execution Time (WCET).
* @exception IllegalActionException If there is a problem determining
* the WCET or a problem accessing the model.
*/
public double getWCET() throws IllegalActionException {
// This probably isn't the best place for this, since
// there are target dependent things here, however I'm not sure
// where else to put it. This should only be called by a Giotto
// director.
if (_debugging) {
_debug("getWCET from Director in codegen Actor package called");
}
double wcet = 0;
double actorFrequency = 0;
double actorWCET = 0;
for (Actor actor : (List<Actor>) ((TypedCompositeActor) this._director
.getContainer()).deepEntityList()) {
Attribute frequency = ((Entity) actor).getAttribute("frequency");
// ptolemy.actor.Director director = actor.getDirector();
// if (director.getClassName().contains("FSM")) {
// // FIXME: This means that codegen depends on the targets.
// ptolemy.codegen.c.targets.openRTOS.domains.fsm.kernel.FSMDirector fsmDir = new ptolemy.codegen.c.targets.openRTOS.domains.fsm.kernel.FSMDirector((ptolemy.domains.fsm.kernel.FSMDirector)this._director);
// return fsmDir.getWCET();
//
// }
// if (director.getClassName().contains("SDF")) {
// // FIXME: This means that codegen depends on the targets.
// ptolemy.codegen.c.targets.openRTOS.domains.sdf.kernel.SDFDirector sdfDir = new ptolemy.codegen.c.targets.openRTOS.domains.sdf.kernel.SDFDirector((ptolemy.domains.sdf.kernel.SDFDirector)this._director);
// return sdfDir.getWCET();
// }
// if (director.getClassName().contains("Giotto")) {
// // FIXME: This means that codegen depends on the targets.
// ptolemy.codegen.c.targets.openRTOS.domains.giotto.kernel.GiottoDirector giottoDir = new ptolemy.codegen.c.targets.openRTOS.domains.giotto.kernel.GiottoDirector((ptolemy.domains.giotto.kernel.GiottoDirector)this._director);
// return giottoDir.getWCET();
//
// }
Attribute WCET = ((Entity) actor).getAttribute("WCET");
if (_debugging) {
_debug(actor.getFullName());
}
if (frequency == null) {
actorFrequency = 1;
} else {
actorFrequency = ((IntToken) ((Variable) frequency).getToken())
.intValue();
}
if (WCET == null) {
actorWCET = 0.01;
} else {
actorWCET = ((DoubleToken) ((Variable) WCET).getToken())
.doubleValue();
}
wcet += actorFrequency * actorWCET;
}
if (_debugging) {
_debug("director " + this.getFullName() + " thinks the WCET is: "
+ wcet);
}
return wcet;
}
/////////////////////////////////////////////////////////////////////
//// protected methods ////
/** Return the minimum number of power of two that is greater than or
* equal to the given integer.
* @param value The given integer.
* @return the minimum number of power of two that is greater than or
* equal to the given integer.
* @exception IllegalActionException If the given integer is not positive.
*/
protected int _ceilToPowerOfTwo(int value) throws IllegalActionException {
if (value < 1) {
throw new IllegalActionException(getComponent(),
"The given integer must be a positive integer.");
}
int powerOfTwo = 1;
while (value > powerOfTwo) {
powerOfTwo <<= 1;
}
return powerOfTwo;
}
/** Return a number of spaces that is proportional to the argument.
* If the argument is negative or zero, return an empty string.
* @param level The level of indenting represented by the spaces.
* @return A string with zero or more spaces.
* @see #_INDENT1
*/
protected static String _getIndentPrefix(int level) {
return StringUtilities.getIndentPrefix(level);
}
/** Update the read offsets of the buffer associated with the given port.
*
* @param port The port whose read offset is to be updated.
* @param code The string buffer that the generated code is appended to.
* @param rate The rate, which must be greater than or equal to 0.
* @exception IllegalActionException If thrown while reading or writing
* offsets, or getting the buffer size, or if the rate is less than 0.
*/
protected void _updatePortOffset(IOPort port, StringBuffer code, int rate)
throws IllegalActionException {
if (rate == 0) {
return;
} else if (rate < 0) {
throw new IllegalActionException(port, "the rate: " + rate
+ " is negative.");
}
PortCodeGenerator portHelper = (PortCodeGenerator) _getHelper(port);
code.append(portHelper.updateOffset(rate, _director));
}
/** Update the offsets of the buffers associated with the ports connected
* with the given port in its downstream.
*
* @param port The port whose directly connected downstream actors update
* their write offsets.
* @param code The string buffer that the generated code is appended to.
* @param rate The rate, which must be greater than or equal to 0.
* @exception IllegalActionException If thrown while reading or writing
* offsets, or getting the buffer size, or if the rate is less than 0.
*/
protected void _updateConnectedPortsOffset(IOPort port, StringBuffer code,
int rate) throws IllegalActionException {
if (rate == 0) {
return;
} else if (rate < 0) {
throw new IllegalActionException(port, "the rate: " + rate
+ " is negative.");
}
PortCodeGenerator portHelper = (PortCodeGenerator) _getHelper(port);
code.append(portHelper.updateConnectedPortsOffset(rate, _director));
}
////////////////////////////////////////////////////////////////////
//// protected variables ////
/** End of line character. Under Unix: "\n", under Windows: "\n\r".
* We use a end of line charactor so that the files we generate
* have the proper end of line character for use by other native tools.
*/
protected static final String _eol;
static {
_eol = StringUtilities.getProperty("line.separator");
}
/** The associated director.
*/
protected ptolemy.actor.Director _director;
/** Indent string for indent level 1.
* @see #_getIndentPrefix(int)
*/
protected static final String _INDENT1 = _getIndentPrefix(1);
/** Indent string for indent level 2.
* @see #_getIndentPrefix(int)
*/
protected static final String _INDENT2 = _getIndentPrefix(2);
/** Indent string for indent level 3.
* @see #_getIndentPrefix(int)
*/
protected static final String _INDENT3 = _getIndentPrefix(3);
/** Indent string for indent level 4.
* @see #_getIndentPrefix(int)
*/
protected static final String _INDENT4 = _getIndentPrefix(4);
}