PeriodicDirector

All Superinterfaces:

Executable, Initializable, Nameable

All Known Implementing Classes:

DistributedSDFDirector, DTDirector, FMIMADirector, HDFDirector, MetroIISequentialSDFDirector, MetroIISRDirector, OptimizingSDFDirector, PSDFDirector, PthalesDirector, SDFDirector, SRDirector
```
public interface PeriodicDirector
extends Executable, Nameable
```
Interface for directors that have a period parameter. These directors are, by default, untimed, but become timed when the period parameter is given a value other than 0.0. The period parameter, if non-zero, specifies the amount of model time that elapses per iteration. In this case, the director should fire only at times that are multiples of the period. If the director is at the top level, then it is responsible for incrementing time between iterations. Otherwise, it is responsible for invoking fireAt() on the enclosing executive director to request subsequent firings, and refusing to fire (by returning false from prefire()) at times that are not multiples of the period.

Since:

Ptolemy II 8.0

Version:

$Id$

Author:

Edward A. Lee

Pt.AcceptedRating:

Red (eal)

Pt.ProposedRating:

Yellow (eal)

Field Summary
- Fields inherited from interface ptolemy.actor.Executable
  COMPLETED, NOT_READY, STOP_ITERATING

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`boolean`	`isEmbedded()`	Return true if this director is embedded inside an opaque composite actor contained by another composite actor.
`double`	`periodValue()`	Return the value of the period as a double.

Methods inherited from interface ptolemy.actor.Executable
fire, 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

- Method Detail
  - isEmbedded
```
boolean isEmbedded()
```
    Return true if this director is embedded inside an opaque composite actor contained by another composite actor. Note that some classes, such as RunCompositeActor, may return false even if they are actually embedded, but they want to be treated as if they were not.
    
    Returns:
    
    True if this directory is embedded inside an opaque composite actor contained by another composite actor.
  - periodValue
```
double periodValue()
            throws IllegalActionException
```
    Return the value of the period as a double.
    
    Returns:
    
    The value of the period as a double.
    
    Throws:
    
    IllegalActionException - If the period parameter cannot be evaluated