ptolemy.domains.ct.lib
Class LinearStateSpace

java.lang.Object
  extended byptolemy.kernel.util.NamedObj
      extended byptolemy.kernel.InstantiableNamedObj
          extended byptolemy.kernel.Entity
              extended byptolemy.kernel.ComponentEntity
                  extended byptolemy.kernel.CompositeEntity
                      extended byptolemy.actor.CompositeActor
                          extended byptolemy.actor.TypedCompositeActor
                              extended byptolemy.domains.ct.lib.LinearStateSpace
All Implemented Interfaces:
ptolemy.actor.Actor, ptolemy.kernel.util.Changeable, java.lang.Cloneable, ptolemy.kernel.util.Debuggable, ptolemy.kernel.util.DebugListener, ptolemy.kernel.util.Derivable, ptolemy.actor.Executable, ptolemy.kernel.util.Instantiable, ptolemy.kernel.util.ModelErrorHandler, ptolemy.kernel.util.MoMLExportable, ptolemy.kernel.util.Nameable, java.io.Serializable, ptolemy.actor.TypedActor

public class LinearStateSpace
extends ptolemy.actor.TypedCompositeActor

Linear state space model in the CT domain.

The State-Space model implements a system whose behavior is defined by:

   dx/dt = Ax + Bu
   y = Cx + Du
   x(0) = x0
   
where x is the state vector, u is the input vector, and y is the output vector. The matrix coefficients must have the following characteristics:
   A must be an n-by-n matrix, where n is the number of states.
   B must be an n-by-m matrix, where m is the number of inputs.
   C must be an r-by-n matrix, where r is the number of outputs.
   D must be an r-by-m matrix.
   
The actor accepts m inputs and generates r outputs through a multi-input port and a multi-output port. The widths of the ports must match the number of rows and columns in corresponding matrices, otherwise, an exception will be thrown.

This actor works like a higher-order function. It is opaque after construction or the change of parameters. Upon preinitialization, the actor will create a subsystem using integrators, adders, and scales. After that, the actor becomes transparent, and the director takes over the control of the actors contained by this actor.

Since:
Ptolemy II 1.0
Version:
$Id: LinearStateSpace.java,v 1.41 2004/04/13 05:13:16 cxh Exp $
Author:
Jie Liu
See Also:
CTBaseIntegrator, Serialized Form
Accepted Rating:
Red (cxh)
Proposed Rating:
Red (liuj)

Nested Class Summary
 
Nested classes inherited from class ptolemy.kernel.CompositeEntity
ptolemy.kernel.CompositeEntity.ContainedObjectsIterator
 
Field Summary
 ptolemy.data.expr.Parameter A
          The A matrix in the state-space representation.
 ptolemy.data.expr.Parameter B
          The B matrix in the state-space representation.
 ptolemy.data.expr.Parameter C
          The C matrix in the state-space representation.
 ptolemy.data.expr.Parameter D
          The D matrix in the state-space representation.
 ptolemy.data.expr.Parameter initialStates
          The initial condition for the state variables.
 ptolemy.actor.TypedIOPort input
          Multi-input port.
 ptolemy.actor.TypedIOPort output
          Multi-output port.
 ptolemy.actor.TypedIOPort stateOutput
          State output multiport.
 
Fields inherited from class ptolemy.actor.CompositeActor
_stopRequested
 
Fields inherited from class ptolemy.kernel.util.NamedObj
_changeListeners, _changeLock, _changeRequests, _debugging, _debugListeners, _elementName, _isPersistent, _workspace, ATTRIBUTES, CLASSNAME, COMPLETE, CONTENTS, DEEP, FULLNAME, LINKS
 
Fields inherited from interface ptolemy.actor.Executable
COMPLETED, NOT_READY, STOP_ITERATING
 
Constructor Summary
LinearStateSpace(ptolemy.kernel.CompositeEntity container, java.lang.String name)
          Construct the composite actor with a name and a container.
 
Method Summary
 void attributeChanged(ptolemy.kernel.util.Attribute attribute)
          If the argument is A, B, C, D or initialState parameters, check that they are indeed matrices and vectors, and request for initialization from the director if there is one.
 ptolemy.actor.Director getDirector()
          Return the executive director, regardless what isOpaque() returns.
 boolean isOpaque()
          Return the opaqueness of this composite actor.
 boolean postfire()
          Request the reinitialization.
 void preinitialize()
          Sanity check the parameters; if the parameters are legal create a continuous-time subsystem that implement the model, preinitialize all the actors in the subsystem, and set the opaqueness of this actor to true.
 void stopFire()
          Stop the current firing.
 void wrapup()
          Set the opaqueness back to true and call the wrapup() method of the super class.
 
Methods inherited from class ptolemy.actor.TypedCompositeActor
_addEntity, _addPort, _addRelation, _checkTypesFromTo, _typeConstraintsFromTo, newPort, newRelation, resolveTypes, typeConstraintList
 
Methods inherited from class ptolemy.actor.CompositeActor
_finishedAddEntity, _setDirector, clone, connectionsChanged, fire, getExecutiveDirector, getFunctionDependency, getManager, initialize, inputPortList, iterate, newInsideReceiver, newReceiver, outputPortList, prefire, requestChange, setContainer, setDirector, setManager, stop, terminate
 
Methods inherited from class ptolemy.kernel.CompositeEntity
_adjustDeferrals, _description, _exportMoMLContents, _removeEntity, _removeRelation, allAtomicEntityList, allowLevelCrossingConnect, classDefinitionList, connect, connect, containedObjectsIterator, deepEntityList, deepGetEntities, entityList, entityList, exportLinks, getAttribute, getEntities, getEntity, getPort, getRelation, getRelations, isAtomic, numberOfClassDefinitions, numberOfEntities, numberOfRelations, numEntities, numRelations, relationList, removeAllEntities, removeAllRelations, uniqueName, validateSettables
 
Methods inherited from class ptolemy.kernel.ComponentEntity
_checkContainer, _getContainedObject, _propagateExistence, getContainer, instantiate, propagateExistence, setName
 
Methods inherited from class ptolemy.kernel.Entity
_removePort, connectedPortList, connectedPorts, getPorts, linkedRelationList, linkedRelations, portList, removeAllPorts, setClassDefinition
 
Methods inherited from class ptolemy.kernel.InstantiableNamedObj
_setParent, exportMoML, getChildren, getElementName, getParent, getPrototypeList, isClassDefinition
 
Methods inherited from class ptolemy.kernel.util.NamedObj
_addAttribute, _attachText, _cloneFixAttributeFields, _debug, _debug, _debug, _debug, _debug, _getIndentPrefix, _isMoMLSuppressed, _markContentsDerived, _propagateValue, _removeAttribute, _splitName, _stripNumericSuffix, addChangeListener, addDebugListener, attributeList, attributeList, attributeTypeChanged, clone, deepContains, depthInHierarchy, description, description, event, executeChangeRequests, exportMoML, exportMoML, exportMoML, exportMoML, getAttribute, getAttributes, getChangeListeners, getClassName, getDerivedLevel, getDerivedList, getFullName, getModelErrorHandler, getName, getName, getSource, handleModelError, isDeferringChangeRequests, isOverridden, isPersistent, message, propagateValue, propagateValues, removeChangeListener, removeDebugListener, setClassName, setDeferringChangeRequests, setDerivedLevel, setModelErrorHandler, setPersistent, setSource, toplevel, toString, workspace
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface ptolemy.actor.Actor
getExecutiveDirector, getFunctionDependency, getManager, inputPortList, newReceiver, outputPortList
 
Methods inherited from interface ptolemy.actor.Executable
fire, initialize, iterate, prefire, stop, terminate
 
Methods inherited from interface ptolemy.kernel.util.Derivable
getDerivedLevel, getDerivedList, propagateValue
 
Methods inherited from interface ptolemy.kernel.util.Nameable
description, getFullName, getName, getName
 

Field Detail

input

public ptolemy.actor.TypedIOPort input
Multi-input port.


output

public ptolemy.actor.TypedIOPort output
Multi-output port.


stateOutput

public ptolemy.actor.TypedIOPort stateOutput
State output multiport.


A

public ptolemy.data.expr.Parameter A
The A matrix in the state-space representation. It must be a square matrix. The default value is [[1.0]].


B

public ptolemy.data.expr.Parameter B
The B matrix in the state-space representation. The number of rows must equal to the number of rows of the A matrix. The number of columns must equal to the width of the input port. The default value is [[1.0]].


C

public ptolemy.data.expr.Parameter C
The C matrix in the state-space representation. The number of columns must equal to the number of columns of the A matrix. The number of rows must equal to the width of the output port. The default value is [[1.0]].


D

public ptolemy.data.expr.Parameter D
The D matrix in the state-space representation. The number of columns must equal to the width of the input port. The number of rows must equal to the width of the output port. The default value is [[0.0]].


initialStates

public ptolemy.data.expr.Parameter initialStates
The initial condition for the state variables. This must be a vector (double matrix with only one row) whose length equals to the number of state variables. The default value is [0.0].

Constructor Detail

LinearStateSpace

public LinearStateSpace(ptolemy.kernel.CompositeEntity container,
                        java.lang.String name)
                 throws ptolemy.kernel.util.NameDuplicationException,
                        ptolemy.kernel.util.IllegalActionException
Construct the composite actor with a name and a container. This constructor creates the ports, parameters, and the icon.

Parameters:
container - The container.
name - The name.
Throws:
ptolemy.kernel.util.NameDuplicationException - If another entity already had this name.
ptolemy.kernel.util.IllegalActionException - If there was an internal problem.
Method Detail

attributeChanged

public void attributeChanged(ptolemy.kernel.util.Attribute attribute)
                      throws ptolemy.kernel.util.IllegalActionException
If the argument is A, B, C, D or initialState parameters, check that they are indeed matrices and vectors, and request for initialization from the director if there is one. Other sanity checks like the dimensions of the matrices will be done in the preinitialize() method.

Parameters:
attribute - The attribute that changed.
Throws:
ptolemy.kernel.util.IllegalActionException - If the numerator and the denominator matrix is not a row vector.

getDirector

public ptolemy.actor.Director getDirector()
Return the executive director, regardless what isOpaque() returns.

Returns:
the executive director.

isOpaque

public boolean isOpaque()
Return the opaqueness of this composite actor. This actor is opaque if it has not been preinitialized after creation or changes of parameters. Otherwise, it is not opaque.


postfire

public boolean postfire()
                 throws ptolemy.kernel.util.IllegalActionException
Request the reinitialization.

Returns:
True if the super class returns true.
Throws:
ptolemy.kernel.util.IllegalActionException - If thrown by super class.

preinitialize

public void preinitialize()
                   throws ptolemy.kernel.util.IllegalActionException
Sanity check the parameters; if the parameters are legal create a continuous-time subsystem that implement the model, preinitialize all the actors in the subsystem, and set the opaqueness of this actor to true. This method needs the write access on the workspace.

Throws:
ptolemy.kernel.util.IllegalActionException - If there is no CTDirector, or any contained actors throw it in its preinitialize() method.

stopFire

public void stopFire()
Stop the current firing. This method overrides the stopFire() method in TypedCompositeActor base class, so that it will not invoke the local director (since there is none). This method should not be called after initialization phase, i.e. when the actor is transparent.


wrapup

public void wrapup()
            throws ptolemy.kernel.util.IllegalActionException
Set the opaqueness back to true and call the wrapup() method of the super class.

Throws:
ptolemy.kernel.util.IllegalActionException - If there is no director.