org.ptolemy.ptango.lib

Class HTMLModelExporter

java.lang.Object

ptolemy.kernel.util.NamedObj

ptolemy.kernel.InstantiableNamedObj

ptolemy.kernel.Entity<T>

ptolemy.kernel.ComponentEntity<T>

ptolemy.actor.AtomicActor<TypedIOPort>

ptolemy.actor.TypedAtomicActor

ptolemy.actor.lib.hoc.ModelReference

ptolemy.vergil.actor.lib.VisualModelReference

org.ptolemy.ptango.lib.HTMLModelExporter

All Implemented Interfaces:

java.lang.Cloneable, Actor, Executable, ExecutionListener, FiringsRecordable, Initializable, TypedActor, Changeable, Debuggable, DebugListener, Derivable, Instantiable, ModelErrorHandler, MoMLExportable, Moveable, Nameable

public class HTMLModelExporter
extends VisualModelReference

A subclass of ModelReference that produces on its output an HTML page for the contained model. FIXME: More Running in a new thread is not supported by HTMLModelExporter.

Since:

Ptolemy II 10.0

Version:

$Id: HTMLModelExporter.java 70398 2014-10-22 23:44:32Z cxh $

Author:

Edward A. Lee and Beth Latronico

See Also:

HTMLText, LinkToOpenTableaux

Accepted Rating:

Red (ltrnc)

Proposed Rating:

Red (ltrnc)

Nested Class Summary

Nested classes/interfaces inherited from class ptolemy.vergil.actor.lib.VisualModelReference

VisualModelReference.LookInside

Nested classes/interfaces inherited from class ptolemy.kernel.Entity

Entity.ContainedObjectsIterator

Field Summary

Fields

Modifier and Type	Field and Description
ColorAttribute	backgroundColor Background color.
Parameter	copyJavaScriptFiles If true, then make an exported web page stand alone.
Parameter	deleteFilesOnExit If true, deleted generated files when the JVM exits.
FileParameter	directoryToExportTo The directory to export files that the output HTML references, such as image files.
Parameter	openCompositesBeforeExport If true, hierarchically open all composite actors in the model before exporting (so that these also get exported, and hyperlinks to them are created).
Parameter	runBeforeExport If true, run the model before exporting (to open plotter or other display windows that get exported).
Parameter	usePtWebsite If true, use the server-side includes of the Ptolemy website.
TypedIOPort	webPage The output port on which to produce HTML text for this web page.

Fields inherited from class ptolemy.vergil.actor.lib.VisualModelReference

_tableau, closeOnPostfire, openOnFiring

Fields inherited from class ptolemy.actor.lib.hoc.ModelReference

_alreadyReadInputs, _model, executionOnFiring, lingerTime, modelFileOrURL, postfireAction, spawnSeparateModels

Fields inherited from class ptolemy.actor.TypedAtomicActor

_typesValid

Fields inherited from class ptolemy.actor.AtomicActor

_actorFiringListeners, _initializables, _notifyingActorFiring, _stopRequested

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

Fields inherited from interface ptolemy.actor.Executable

COMPLETED, NOT_READY, STOP_ITERATING

Constructor Summary

Constructors

Constructor and Description
HTMLModelExporter(CompositeEntity container, java.lang.String name) Create an instance of this parameter.

Method Summary

Modifier and Type	Method and Description
void	attributeChanged(Attribute attribute) React to a change in an attribute.
java.lang.Object	clone(Workspace workspace) Clone the attribute.
void	fire() Run a complete execution of the referenced model.

Methods inherited from class ptolemy.vergil.actor.lib.VisualModelReference

postfire

Methods inherited from class ptolemy.actor.lib.hoc.ModelReference

_readInputsAndValidateSettables, executionError, executionFinished, managerStateChanged, stop, stopFire, terminate, wrapup

Methods inherited from class ptolemy.actor.TypedAtomicActor

_containedTypeConstraints, _customTypeConstraints, _defaultTypeConstraints, _fireAt, _fireAt, attributeTypeChanged, clone, isBackwardTypeInferenceEnabled, newPort, typeConstraintList, typeConstraints

Methods inherited from class ptolemy.actor.AtomicActor

_actorFiring, _actorFiring, _declareDelayDependency, addActorFiringListener, addInitializable, connectionsChanged, createReceivers, declareDelayDependency, getCausalityInterface, getDirector, getExecutiveDirector, getManager, initialize, inputPortList, isFireFunctional, isStrict, iterate, newReceiver, outputPortList, prefire, preinitialize, pruneDependencies, recordFiring, removeActorFiringListener, removeDependency, removeInitializable, setContainer

Methods inherited from class ptolemy.kernel.ComponentEntity

_adjustDeferrals, _checkContainer, _getContainedObject, _propagateExistence, getContainer, instantiate, isAtomic, isOpaque, moveDown, moveToFirst, moveToIndex, moveToLast, moveUp, propagateExistence, setName

Methods inherited from class ptolemy.kernel.Entity

_addPort, _description, _exportMoMLContents, _removePort, _validateSettables, connectedPortList, connectedPorts, containedObjectsIterator, getAttribute, getPort, getPorts, linkedRelationList, linkedRelations, portList, removeAllPorts, setClassDefinition, uniqueName

Methods inherited from class ptolemy.kernel.InstantiableNamedObj

_setParent, exportMoML, getChildren, getElementName, getParent, getPrototypeList, isClassDefinition, isWithinClassDefinition

Methods inherited from class ptolemy.kernel.util.NamedObj

_addAttribute, _adjustOverride, _attachText, _cloneFixAttributeFields, _containedDecorators, _copyChangeRequestList, _debug, _debug, _debug, _debug, _debug, _executeChangeRequests, _getIndentPrefix, _isMoMLSuppressed, _markContentsDerived, _notifyHierarchyListenersAfterChange, _notifyHierarchyListenersBeforeChange, _propagateValue, _removeAttribute, _splitName, _stripNumericSuffix, addChangeListener, addDebugListener, addHierarchyListener, attributeDeleted, attributeList, attributeList, decorators, deepContains, depthInHierarchy, description, description, event, executeChangeRequests, exportMoML, exportMoML, exportMoML, exportMoML, exportMoMLPlain, getAttribute, getAttributes, getChangeListeners, getClassName, getDecoratorAttribute, getDecoratorAttributes, getDerivedLevel, getDerivedList, getDisplayName, getFullName, getModelErrorHandler, getName, getName, getSource, handleModelError, isDeferringChangeRequests, isOverridden, isPersistent, lazyContainedObjectsIterator, message, notifyOfNameChange, propagateValue, propagateValues, removeAttribute, removeChangeListener, removeDebugListener, removeHierarchyListener, requestChange, setClassName, setDeferringChangeRequests, setDerivedLevel, setDisplayName, setModelErrorHandler, setPersistent, setSource, sortContainedObjects, toplevel, toString, validateSettables, workspace

Methods inherited from class java.lang.Object

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

Methods inherited from interface ptolemy.actor.Actor

createReceivers, getCausalityInterface, getDirector, getExecutiveDirector, getManager, inputPortList, newReceiver, outputPortList

Methods inherited from interface ptolemy.actor.Executable

isFireFunctional, isStrict, iterate, prefire

Methods inherited from interface ptolemy.actor.Initializable

addInitializable, initialize, preinitialize, removeInitializable

Methods inherited from interface ptolemy.kernel.util.Nameable

description, getContainer, getDisplayName, getFullName, getName, getName, setName

Methods inherited from interface ptolemy.kernel.util.Derivable

getDerivedLevel, getDerivedList, propagateValue

Field Detail

backgroundColor

public ColorAttribute backgroundColor

Background color. By default this is blank, which indicates to use the background color of the model.

copyJavaScriptFiles

public Parameter copyJavaScriptFiles

If true, then make an exported web page stand alone. Instead of referencing JavaScript and image files on the ptolemy.org website, if this parameter is true, then the required files will be copied into the target directory. This is a boolean that defaults to false.

deleteFilesOnExit

public Parameter deleteFilesOnExit

If true, deleted generated files when the JVM exits.

directoryToExportTo

public FileParameter directoryToExportTo

The directory to export files that the output HTML references, such as image files. If a relative name is given, then it is relative to the location of the model file. By default, this is blank, which will result in writing to a directory with name equal to the sanitized name of the model, and the directory will be contained in the same location where the model that contains this attribute is stored.

openCompositesBeforeExport

public Parameter openCompositesBeforeExport

If true, hierarchically open all composite actors in the model before exporting (so that these also get exported, and hyperlinks to them are created). This is a boolean that defaults to false.

runBeforeExport

public Parameter runBeforeExport

If true, run the model before exporting (to open plotter or other display windows that get exported). Note that it is important the model have a finite run. This is a boolean that defaults to false.

usePtWebsite

public Parameter usePtWebsite

If true, use the server-side includes of the Ptolemy website. This is a boolean that defaults to false. This parameter is marked as an expert parameter, so by default, it is not visible.

webPage

public TypedIOPort webPage

The output port on which to produce HTML text for this web page. This has type string.

Constructor Detail

HTMLModelExporter

public HTMLModelExporter(CompositeEntity container,
                         java.lang.String name)
                  throws IllegalActionException,
                         NameDuplicationException

Create an instance of this parameter.

Parameters:

container - The container.

name - The name.

Throws:

IllegalActionException - If the superclass throws it.

NameDuplicationException - If the superclass throws it.

Method Detail

attributeChanged

public void attributeChanged(Attribute attribute)
                      throws IllegalActionException

React to a change in an attribute.

Overrides:

attributeChanged in class VisualModelReference

Parameters:

attribute - The attribute that changed.

Throws:

IllegalActionException - If the change is not acceptable to this container (not thrown in this base class).

clone

public java.lang.Object clone(Workspace workspace)
                       throws java.lang.CloneNotSupportedException

Clone the attribute.

Overrides:

clone in class VisualModelReference

Parameters:

workspace - The workspace in which to place the cloned attribute.

Returns:

The cloned attribute.

Throws:

java.lang.CloneNotSupportedException - Not thrown in this base class.

See Also:

Object.clone()

fire

public void fire()
          throws IllegalActionException

Description copied from class: VisualModelReference

Run a complete execution of the referenced model. A complete execution consists of invocation of super.initialize(), repeated invocations of super.prefire(), super.fire(), and super.postfire(), followed by super.wrapup(). The invocations of prefire(), fire(), and postfire() are repeated until either the model indicates it is not ready to execute (prefire() returns false), or it requests a stop (postfire() returns false or stop() is called). Before running the complete execution, this method examines input ports, and if they are connected, have data, and if the referenced model has a top-level parameter with the same name, then one token is read from the input port and used to set the value of the parameter in the referenced model. After running the complete execution, if there are any output ports, then this method looks for top-level parameters in the referenced model with the same name as the output ports, and if there are any, reads their values and produces them on the output. If no model has been specified, then this method does nothing.

Specified by:

fire in interface Executable

Overrides:

fire in class VisualModelReference

Throws:

IllegalActionException - If there is no director, or if the director's action methods throw it.