org.kepler.gis.actor.landscape

Class CreateLandscape

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.kepler.gis.actor.landscape.CreateLandscape

All Implemented Interfaces:

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

public class CreateLandscape
extends TypedAtomicActor

Create a Landscape file from component raster layers.

Author:

Daniel Crawl

Nested Class Summary

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

Entity.ContainedObjectsIterator

Field Summary

Fields

Modifier and Type	Field and Description
TypedIOPort	aspect Aspect raster (required).
TypedIOPort	canopyBaseHeight Canopy base height raster (optional).
TypedIOPort	canopyBulkDensity Canopy bulk density raster (optional).
TypedIOPort	canopyCover Canoopy cover raster (required).
TypedIOPort	canopyHeight Canopy height raster (optional).
Parameter	deleteInputsOnWrapup If true, delete input raster files when workflow stops execution.
Parameter	deleteOutputOnWrapup If true, delete output raster files when workflow stops execution.
TypedIOPort	duff Duff raster (optional).
TypedIOPort	elevation Elevation raster (required).
TypedIOPort	fuel Fuel models raster (required).
StringParameter	lcpmake Path and name to lcpmake program.
TypedIOPort	out Path and name of landscape file that's created.
PortParameter	outputName Path and name of landscape file to write.
TypedIOPort	slope Slope raster (required).
TypedIOPort	woody Woody raster (optional).

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
CreateLandscape(CompositeEntity container, java.lang.String name)

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone(Workspace workspace) Clone this actor into the specified workspace.
void	fire() Do nothing.
void	preinitialize() Create receivers and declare delay dependencies.
void	wrapup() Do nothing except invoke the wrapup() methods of any objects that have been registered with addInitializable().

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, postfire, prefire, pruneDependencies, recordFiring, removeActorFiringListener, removeDependency, removeInitializable, setContainer, stop, stopFire, terminate

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, 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

elevation

public TypedIOPort elevation

Elevation raster (required).

slope

public TypedIOPort slope

Slope raster (required).

aspect

public TypedIOPort aspect

Aspect raster (required).

fuel

public TypedIOPort fuel

Fuel models raster (required).

canopyCover

public TypedIOPort canopyCover

Canoopy cover raster (required).

canopyHeight

public TypedIOPort canopyHeight

Canopy height raster (optional).

canopyBaseHeight

public TypedIOPort canopyBaseHeight

Canopy base height raster (optional).

canopyBulkDensity

public TypedIOPort canopyBulkDensity

Canopy bulk density raster (optional).

duff

public TypedIOPort duff

Duff raster (optional).

woody

public TypedIOPort woody

Woody raster (optional).

lcpmake

public StringParameter lcpmake

Path and name to lcpmake program.

outputName

public PortParameter outputName

Path and name of landscape file to write.

deleteInputsOnWrapup

public Parameter deleteInputsOnWrapup

If true, delete input raster files when workflow stops execution.

deleteOutputOnWrapup

public Parameter deleteOutputOnWrapup

If true, delete output raster files when workflow stops execution.

out

public TypedIOPort out

Path and name of landscape file that's created.

Constructor Detail

CreateLandscape

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

Throws:

IllegalActionException

NameDuplicationException

Method Detail

clone

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

Clone this actor into the specified workspace.

Overrides:

clone in class TypedAtomicActor

Parameters:

workspace - The workspace for the new object.

Returns:

A new actor.

Throws:

java.lang.CloneNotSupportedException - If a derived class contains an attribute that cannot be cloned.

See Also:

NamedObj.exportMoML(Writer, int, String), NamedObj.setDeferringChangeRequests(boolean)

fire

public void fire()
          throws IllegalActionException

Description copied from class: AtomicActor

Do nothing. Derived classes override this method to define their primary run-time action.

Specified by:

fire in interface Executable

Overrides:

fire in class AtomicActor<TypedIOPort>

Throws:

IllegalActionException - Not thrown in this base class.

preinitialize

public void preinitialize()
                   throws IllegalActionException

Description copied from class: AtomicActor

Create receivers and declare delay dependencies. Derived classes can override this method to perform additional initialization functions, but they should call this base class methods or create the receivers themselves. This method gets executed exactly once prior to any other action methods. It cannot produce output data since type resolution is typically not yet done. It also gets invoked prior to any static scheduling that might occur in the domain, so it can change scheduling information.

Specified by:

preinitialize in interface Initializable

Overrides:

preinitialize in class AtomicActor<TypedIOPort>

Throws:

IllegalActionException - Not thrown in this base class.

wrapup

public void wrapup()
            throws IllegalActionException

Description copied from class: AtomicActor

Do nothing except invoke the wrapup() methods of any objects that have been registered with addInitializable(). Derived classes override this method to define operations to be performed exactly once at the end of a complete execution of an application. It typically closes files, displays final results, etc.

Specified by:

wrapup in interface Initializable

Overrides:

wrapup in class AtomicActor<TypedIOPort>

Throws:

IllegalActionException - Not thrown in this base class.