ptolemy.kernel.util

Interface DebugEvent

All Known Implementing Classes:

EventDebugEvent, FiringEvent, IOPortEvent, PteraDebugEvent, PteraErrorEvent, StateEvent, TypeEvent

public interface DebugEvent

An interface for events that can be used for debugging. These events will generally be subclassed to create events with more meaning (such as a FiringEvent). Debug events should always have a useful string representation, so that the generic listeners (such as StreamListener) can display them reasonably. This string representation should be provided by the toString() method.

Since:

Ptolemy II 1.0

Version:

$Id: DebugEvent.java 70398 2014-10-22 23:44:32Z cxh $

Author:

Steve Neuendorffer

See Also:

DebugListener, Debuggable, FiringEvent

Accepted Rating:

Green (neuendor)

Proposed Rating:

Green (neuendor)

Method Summary

Modifier and Type	Method and Description
NamedObj	getSource() Return the source of the event.
java.lang.String	toString() Return a string representation of this event.

Method Detail

getSource

NamedObj getSource()

Return the source of the event.

Returns:

The ptolemy object that published this event.

toString

java.lang.String toString()

Return a string representation of this event.

Overrides:

toString in class java.lang.Object

Returns:

A user-readable string describing the event.