drcl.comp.contract
Class EventContract

java.lang.Object
  |
  +--drcl.comp.Contract
        |
        +--drcl.comp.contract.EventContract

public class EventContract

extends Contract

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

An event message contains the following fields:

FIELD	TYPE	DESCRIPTION
Time	double	Time when the event occurs and this message is exported.
Port	String	Path of the port where this message is originated.
Event Name	String	Name of the event.
Event Object	Object	Object of the event.
Description	Object	Description of the event.

Inner Class Summary

static class

EventContract.Message

Field Summary

static EventContract

INSTANCE

Fields inherited from class drcl.comp.Contract

Role_INITIATOR, Role_PEER, Role_REACTOR

Constructor Summary

EventContract()

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 EventContract INSTANCE

Constructor Detail

EventContract

public EventContract()

Method Detail

getName

public java.lang.String getName()

Overrides:

getName in class Contract

getContractContent

public java.lang.Object getContractContent()

Description copied from class: Contract

Returns the content of this contract (format?).

Overrides:

getContractContent in class Contract