edu::wpi::hri::bml::net::Place Class Reference

Inheritance diagram for edu::wpi::hri::bml::net::Place:

[legend]

List of all members.

Public Member Functions
boolean	addOutput (Transition t)
boolean	existsCycle (List< PetriPart > beento)
Transition	getInput ()
String	getName ()
Set< Transition >	getOutputs ()
boolean	replaceInput (Transition oldt, Transition newt)
boolean	replaceOutput (Transition oldt, Transition newt)
boolean	setInput (Transition t)
Protected Member Functions
boolean	checkRequirements ()
	Place (ThreadGroup group, Logger sublog, String name)
void	sendTokens ()
void	tokenFrom (PetriPart from)
Private Attributes
Transition	input
final String	name
Set< Transition >	outputs
boolean	ready

---

Detailed Description

The Place class holds information for generic places. This class should be subclassed for special actions.

Author:

Aaron Holroyd (aholroyd (at) wpi (dot) edu)

Definition at line 49 of file Place.java.

---

Constructor & Destructor Documentation

edu::wpi::hri::bml::net::Place::Place	(	ThreadGroup	group,
		Logger	sublog,
		String	name
	)			[inline, protected]

Create a new place which has no transitions in or out.

Parameters:

	group	The thread group to add this thread to.
	sublog	The logger to use as a base for this logger
	name	The name to give to the logger

Definition at line 66 of file Place.java.

---

Member Function Documentation

boolean edu::wpi::hri::bml::net::Place::addOutput

(

Transition

t

)

[inline]

Add an output that should be sent a token upon completion of this Place.

Parameters:

p

The transition to send a token to.

Returns:

True if the transition was added.

Definition at line 139 of file Place.java.

boolean edu::wpi::hri::bml::net::Place::checkRequirements

(

)

[inline, protected, virtual]

This method must implement the check of waiting for "all" previous parts. If a part does not need to wait for all, but instead one, it should return true upon the first input.

Returns:

True for starting requirements met, false otherwise.

Implements edu::wpi::hri::bml::net::PetriPart.

Definition at line 79 of file Place.java.

boolean edu::wpi::hri::bml::net::Place::existsCycle

(

List< PetriPart >

beento

)

[inline, virtual]

Implements edu::wpi::hri::bml::net::PetriPart.

Definition at line 95 of file Place.java.

Transition edu::wpi::hri::bml::net::Place::getInput

(

)

[inline]

Get the input Transition of this Place

Returns:

the input transition.

Definition at line 128 of file Place.java.

String edu::wpi::hri::bml::net::Place::getName

(

)

[inline]

Definition at line 74 of file Place.java.

Set<Transition> edu::wpi::hri::bml::net::Place::getOutputs

(

)

[inline]

get the output transitions from this Place.

Returns:

the output transition.

Definition at line 148 of file Place.java.

boolean edu::wpi::hri::bml::net::Place::replaceInput	(	Transition	oldt,
		Transition	newt
	)			[inline]

Replace input transition oldt with transition newt.

Parameters:

	oldt	The transition to be removed.
	newt	The transition to be added.

Returns:

True for success (oldt was turned into a newt), false otherwise.

Definition at line 180 of file Place.java.

boolean edu::wpi::hri::bml::net::Place::replaceOutput	(	Transition	oldt,
		Transition	newt
	)			[inline]

Replace output transition oldt with transition newt.

Parameters:

	oldt	The transition to be removed.
	newt	The transition to be added.

Returns:

True for success (oldt was turned into a newt), false otherwise.

Definition at line 161 of file Place.java.

void edu::wpi::hri::bml::net::Place::sendTokens

(

)

[inline, protected, virtual]

Tell the subclass to send all of the tokens. This should call the sendSignalTo method.

Implements edu::wpi::hri::bml::net::PetriPart.

Definition at line 84 of file Place.java.

boolean edu::wpi::hri::bml::net::Place::setInput

(

Transition

t

)

[inline]

Set the input that can activate this Place.

Parameters:

t

The transition that can activate this.

Returns:

True if the input to this transition was null.

Definition at line 115 of file Place.java.

void edu::wpi::hri::bml::net::Place::tokenFrom

(

PetriPart

from

)

[inline, protected, virtual]

Let the subclass know that a token has been received from the given part.

Parameters:

from

The part which is sending a token to this part.

Implements edu::wpi::hri::bml::net::PetriPart.

Definition at line 89 of file Place.java.

---

Member Data Documentation

Transition edu::wpi::hri::bml::net::Place::input [private]

Definition at line 51 of file Place.java.

final String edu::wpi::hri::bml::net::Place::name [private]

Definition at line 54 of file Place.java.

Set<Transition> edu::wpi::hri::bml::net::Place::outputs [private]

Definition at line 52 of file Place.java.

boolean edu::wpi::hri::bml::net::Place::ready [private]

Definition at line 53 of file Place.java.

---

The documentation for this class was generated from the following file:

• bml_realizer/src/edu/wpi/hri/bml/net/Place.java