Package ptolemy.component

Class ComponentDirector

java.lang.Object

ptolemy.component.ComponentDirector

All Implemented Interfaces:

Component

Direct Known Subclasses:

PtinyOSDirector

public class ComponentDirector
extends java.lang.Object
implements Component

FIXME

Since:

Ptolemy II 11.0

Version:

$Id$

Author:

Yang Zhao and Edward A. Lee

Pt.AcceptedRating:

red (davisj)

Pt.ProposedRating:

yellow (ellen_zh)

Constructor Summary

Constructors

Constructor	Description
ComponentDirector()

Method Summary

Modifier and Type	Method	Description
void	initialize()	Initialize the component.
void	preinitialize()	Preinitialize the component.
void	run()	Execute the component.
void	wrapup()	Wrap up an execution.

Methods inherited from class java.lang.Object

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

Constructor Detail

ComponentDirector

public ComponentDirector()

Method Detail

initialize

public void initialize()
                throws IllegalActionException

Initialize the component. This is invoked once after preinitialize() and again whenever the component needs to be reinitialized.

Specified by:

initialize in interface Component

Throws:

IllegalActionException - If initialization cannot be completed.

preinitialize

public void preinitialize()
                   throws IllegalActionException

Preinitialize the component. This is invoked exactly once per execution of a model, before any other methods in this interface are invoked.

Specified by:

preinitialize in interface Component

Throws:

IllegalActionException - If preinitialization cannot be completed.

run

public void run()
         throws IllegalActionException

Execute the component. This is invoked after preinitialize() and initialize(), and may be invoked repeatedly.

Specified by:

run in interface Component

Throws:

IllegalActionException - If the run cannot be completed.

wrapup

public void wrapup()
            throws IllegalActionException

Wrap up an execution. This method is invoked exactly once per execution of a model. It finalizes an execution, typically closing files, displaying final results, etc. If any other method from this interface is invoked after this, it must begin with preinitialize().

Specified by:

wrapup in interface Component

Throws:

IllegalActionException - If wrapup fails.