org.kepler.provenance

Class ProvenanceEvent

java.lang.Object

org.kepler.provenance.ProvenanceEvent

All Implemented Interfaces:

DebugEvent

public class ProvenanceEvent
extends java.lang.Object
implements DebugEvent

An event that is published by actors as they fire to report provenance. Any actor that wants to record extra provenance about how it is carrying out its job, can create and publish these events using the _debug method.

Author:

Karen Schuchardt

See Also:

ptolemy.actor.FiringEvent;, DebugListener

Field Summary

Fields

Modifier and Type	Field and Description
protected Actor	_actor
protected java.util.Map<java.lang.String,java.lang.String>	_map

Constructor Summary

Constructors

Constructor and Description
ProvenanceEvent(Actor actor, java.util.Map<java.lang.String,java.lang.String> map)

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.String>	getMap()
NamedObj	getSource() Return the source of the event.
java.lang.String	toString() Return a string representation of this event.

Methods inherited from class java.lang.Object

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

Field Detail

_actor

protected Actor _actor

_map

protected java.util.Map<java.lang.String,java.lang.String> _map

Constructor Detail

ProvenanceEvent

public ProvenanceEvent(Actor actor,
                       java.util.Map<java.lang.String,java.lang.String> map)

Method Detail

getMap

public java.util.Map<java.lang.String,java.lang.String> getMap()

getSource

public NamedObj getSource()

Return the source of the event.

Specified by:

getSource in interface DebugEvent

Returns:

The ptolemy object that published this event.

toString

public java.lang.String toString()

Return a string representation of this event.

Specified by:

toString in interface DebugEvent

Overrides:

toString in class java.lang.Object

Returns:

A user-readable string describing the event.