drcl.comp.contract
Class TraceContract

java.lang.Object
  drcl.comp.Contract
      drcl.comp.contract.TraceContract

public class TraceContract

extends Contract

Defines the format of the trace message exported by a component and provides utility methods to retrieve individual fields in such a message.

A trace message is exported by a component when data is sent from or arrives at the component.

Specifically, a trace message contains the following fields:

FIELD	TYPE	DESCRIPTION
Trace	String	Two types of traces are defined. A "SEND" trace message is exported for data sent. A "DATA" trace message is exported for arriving data.
Time	double	Time when this message is exported.
Where	String	Path of the port where the sending or receiving takes place.
Description	Object	Content of the data being sent/received.

Nested Class Summary

static class

TraceContract.Message

Field Summary

static TraceContract

INSTANCE

Fields inherited from class drcl.comp.Contract

Role_INITIATOR, Role_PEER, Role_REACTOR

Constructor Summary

TraceContract()

Method Summary

java.lang.Object	getContractContent() Returns the content of this contract (format?).
java.lang.String	getName()

Methods inherited from class drcl.comp.Contract

getRole, match, setRole

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static final TraceContract INSTANCE

Constructor Detail

TraceContract

public TraceContract()

Method Detail

getName

public java.lang.String getName()

Specified by:

getName in class Contract

getContractContent

public java.lang.Object getContractContent()

Description copied from class: Contract

Returns the content of this contract (format?).

Specified by:

getContractContent in class Contract