ptolemy.actor.util

Class ActorDependencies

java.lang.Object

ptolemy.actor.util.ActorDependencies

public class ActorDependencies
extends java.lang.Object

Utilities for data dependencies between actors.

Since:

Ptolemy II 10.0

Version:

$Id$

Author:

Christopher Brooks

Pt.AcceptedRating:

Red (cxh)

Pt.ProposedRating:

Yellow (cxh)

Method Summary

Modifier and Type	Method and Description
static java.util.Set<AtomicActor>	dependents(Actor actor) Return a Set of dependent (downstream) atomic actors that are connected to the target.
static java.util.Set<AtomicActor>	dependents(Actor actor, java.lang.Class filter) Return a Set of dependent (downstream) actors of a particular class that are connected to the target.
static java.util.Set<AtomicActor>	dependents(IOPort port, java.lang.Class filter) Return a Set of dependent (downstream) actors of a particular class that are connected to a port.
static java.util.Set<AtomicActor>	prerequisites(Actor actor) Return a Set of AtomicActors that are connected upstream to this AtomicActor.
static java.util.Set<AtomicActor>	prerequisites(Actor actor, java.lang.Class filter) Return a Set of actors that match the specified filter that are connected upstream to the specified actor.

Methods inherited from class java.lang.Object

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

Method Detail

dependents

public static java.util.Set<AtomicActor> dependents(Actor actor)
                                             throws KernelException

Return a Set of dependent (downstream) atomic actors that are connected to the target. Opaque composite actors are searched. For output ports of the specified actor, these are downstream actors that are connected on the outside. For input ports of the specified actor, these are downstream actors connected on the inside.

Parameters:

actor - the Actor to be searched.

Returns:

A Set of dependent atomic actors.

Throws:

KernelException - If there is a problem with the receivers. the top level or if preinitialize() fails.

dependents

public static java.util.Set<AtomicActor> dependents(Actor actor,
                                                    java.lang.Class filter)
                                             throws KernelException

Return a Set of dependent (downstream) actors of a particular class that are connected to the target. Opaque composite actors are searched. For output ports of the specified actor, these are downstream actors that are connected on the outside. For input ports of the specified actor, these are downstream actors connected on the inside.

Parameters:

actor - the Actor to be searched.

filter - The class of prerequisite actors to be returned.

Returns:

A Set of dependent atomic actors

Throws:

KernelException - If there is a problem with the receivers. the top level or if preinitialize() fails.

dependents

public static java.util.Set<AtomicActor> dependents(IOPort port,
                                                    java.lang.Class filter)
                                             throws KernelException

Return a Set of dependent (downstream) actors of a particular class that are connected to a port. Opaque composite actors are searched. For output ports of the specified actor, these are downstream actors that are connected on the outside. For input ports of the specified actor, these are downstream actors connected on the inside.

Parameters:

port - The target port.

filter - The class of prerequisite actors to be returned.

Returns:

A Set of dependent atomic actors

Throws:

KernelException - If there is a problem with the receivers. the top level or if preinitialize() fails.

prerequisites

public static java.util.Set<AtomicActor> prerequisites(Actor actor)
                                                throws KernelException

Return a Set of AtomicActors that are connected upstream to this AtomicActor.

Parameters:

actor - the Actor to be searched.

Returns:

A Set of AtomicActors that are connected to this AtomicActor.

Throws:

KernelException - If thrown when a Manager is added to the top level or if preinitialize() fails.

prerequisites

public static java.util.Set<AtomicActor> prerequisites(Actor actor,
                                                       java.lang.Class filter)
                                                throws KernelException

Return a Set of actors that match the specified filter that are connected upstream to the specified actor. If an upstream actor does not match the filter, then look through it to other actors connected further upstream. Upstream actors include any that can send data to the specified actor.

Parameters:

actor - the Actor to be searched.

filter - The class of prerequisite actors to be returned.

Returns:

A Set of AtomicActors that are connected to this AtomicActor.

Throws:

KernelException - If thrown when a Manager is added to the top level or if preinitialize() fails.