org.geon

Class AddPointToSVG

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

org.geon.AddPointToSVG

All Implemented Interfaces:

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

public class AddPointToSVG
extends TypedAtomicActor

This actor accepts a point and an SVG file and adds the point to the SVG file. The point is defined as and array of doubles ({X,Y}). The SVG file may have conversion ratios for X and Y, specified by a conversion and xRatio, yRatio tags. The X,Y values are converted using these factors (if available). The point is added as a tag to the SVG file. The resulting SVG content is saved to svgOutFile. An example SVG file is available at lib/testdata/geon/whalen.svg.

Since:

Ptolemy II 3.0.2

Author:

Efrat Jaeger

UserLevelDocumentation:

This actor accepts a point, represented as an X,Y array and an SVG file and adds the point to the SVG file. If the file contains, xRatio, yRatio conversion tags, the X,Y values will be converted accordingly. The resulting SVG content is saved to svgOutFile. This actor is typically used for display purposes. An example SVG file is available at lib/testdata/geon/whalen.svg.

Nested Class Summary

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

Entity.ContainedObjectsIterator

Field Summary

Fields

Modifier and Type	Field and Description
Parameter	confirmOverwrite If false, then overwrite the specified file if it exists without asking.
TypedIOPort	output Outputs the SVG output file path.
TypedIOPort	point Point to be added.
TypedIOPort	svgFile An SVG inupt file port.
FileParameter	svgFileParam An SVG input file name or URL.
FileParameter	svgOutFile An SVG output file name or URL.
TypedIOPort	svgOutputFile An SVG output file port.
TypedIOPort	trigger Triggering the actor execution.

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
AddPointToSVG(CompositeEntity container, java.lang.String name) Construct an actor with the given container and name.

Method Summary

Modifier and Type	Method and Description
void	fire() Translate the point into the svg ratio parameters and add it to the file.

Methods inherited from class ptolemy.actor.TypedAtomicActor

_containedTypeConstraints, _customTypeConstraints, _defaultTypeConstraints, _fireAt, _fireAt, attributeTypeChanged, clone, 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, postfire, prefire, preinitialize, pruneDependencies, recordFiring, removeActorFiringListener, removeDependency, removeInitializable, setContainer, stop, stopFire, terminate, wrapup

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, attributeChanged, 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, postfire, prefire, stop, stopFire, terminate

Methods inherited from interface ptolemy.actor.Initializable

addInitializable, initialize, preinitialize, removeInitializable, wrapup

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

point

public TypedIOPort point

Point to be added. An array of doubles, {X,Y}.

UserLevelDocumentation:

The point to be added to the SVG file. An array of doubles of the following format: {X,Y}.

svgFile

public TypedIOPort svgFile

An SVG inupt file port.

UserLevelDocumentation:

The path to the SVG file to be updated.

svgOutputFile

public TypedIOPort svgOutputFile

An SVG output file port.

UserLevelDocumentation:

The path to the output SVG file.

output

public TypedIOPort output

Outputs the SVG output file path.

UserLevelDocumentation:

The actor output the path to the modified SVG file.

trigger

public TypedIOPort trigger

Triggering the actor execution.

UserLevelDocumentation:

This port is used to trigger the actor.

svgFileParam

public FileParameter svgFileParam

An SVG input file name or URL. This is a string with any form accepted by FileParameter.

See Also:

FileParameter

UserLevelDocumentation:

The path to the SVG file to be updated.

svgOutFile

public FileParameter svgOutFile

An SVG output file name or URL. This is a string with any form accepted by FileParameter.

See Also:

FileParameter

UserLevelDocumentation:

The path to the output SVG file.

confirmOverwrite

public Parameter confirmOverwrite

If false, then overwrite the specified file if it exists without asking. If true (the default), then if the file exists, ask for confirmation before overwriting.

UserLevelDocumentation:

If false, then overwrite the specified file if it exists without asking. If true (the default), then if the file exists, ask for confirmation before overwriting.

Constructor Detail

AddPointToSVG

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

Construct an actor with the given container and name.

Parameters:

container - The container.

name - The name of this actor.

Throws:

IllegalActionException - If the actor cannot be contained by the proposed container.

NameDuplicationException - If the container already has an actor with this name.

Method Detail

fire

public void fire()
          throws IllegalActionException

Translate the point into the svg ratio parameters and add it to the file. Broadcast the URL to the svg output file.

Specified by:

fire in interface Executable

Overrides:

fire in class AtomicActor<TypedIOPort>

Throws:

IllegalActionException - If there's no director.