ptolemy.domains.sequence.kernel

Interface MultipleFireMethodsInterface

All Known Implementing Classes:

BaseMultipleMethodsActor, SequencedIntegrator

public interface MultipleFireMethodsInterface

The interface for actors with multiple fire methods that can be separately scheduled in the Sequence and Process Directors.

Since:

Ptolemy II 10.0

Version:

$Id$

Author:

Charles Shelton

See Also:

SequencedModelDirector, SequenceScheduler, SequenceSchedule

Pt.AcceptedRating:

Red (cshelton)

Pt.ProposedRating:

Red (cshelton)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDefaultFireMethodName() Return the name of the default fire method for this actor.
java.util.List<java.lang.String>	getFireMethodNames() Return the list of strings that represent the names of all the fire methods the actor has.
java.util.List<IOPort>	getMethodInputPortList(java.lang.String methodName) Return the list of input ports associated with the given method name.
IOPort	getMethodOutputPort(java.lang.String methodName) Return the output port associated with the given method name, if there is one.
int	numFireMethods() Return the number of fire methods the actor has.
void	setFireMethod(java.lang.String methodName) Set the fire method to the method that matches the specified string name.

Method Detail

getDefaultFireMethodName

java.lang.String getDefaultFireMethodName()

Return the name of the default fire method for this actor.

Returns:

The string name of the default fire method for the actor. If the actor does not have multiple fire methods, return null.

getFireMethodNames

java.util.List<java.lang.String> getFireMethodNames()

Return the list of strings that represent the names of all the fire methods the actor has.

Returns:

The list of fire method names strings.

getMethodInputPortList

java.util.List<IOPort> getMethodInputPortList(java.lang.String methodName)

Return the list of input ports associated with the given method name. If the method has no input ports, return an empty list. If the actor does not have multiple methods, return null.

Parameters:

methodName - The specified method name.

Returns:

The list of input ports associated with the method name.

getMethodOutputPort

IOPort getMethodOutputPort(java.lang.String methodName)

Return the output port associated with the given method name, if there is one. If the method does not have any outputs, or the actor does not have multiple fire methods, return null

Parameters:

methodName - The specified name of the method.

Returns:

The output port associated with this method, or null is there is none.

numFireMethods

int numFireMethods()

Return the number of fire methods the actor has.

Returns:

the number of fire methods the actor has, which should be at least one.

setFireMethod

void setFireMethod(java.lang.String methodName)
            throws IllegalActionException

Set the fire method to the method that matches the specified string name.

Parameters:

methodName - The name of the method to be used.

Throws:

IllegalActionException - If the specified fire method cannot be found in the actor.