drcl.comp.contract
Class GarbageContract

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

public class GarbageContract

extends Contract

Defines the format of the garbage message exported by a component and provides utility methods to retrieve individual fields in such a message. A garbage message describes unwanted data being discarded by a component. It is equipped with a displayable flag for users to control display of garbage messages from selected components.

Specifically, a garbage message contains the following fields:

FIELD	TYPE	DESCRIPTION
Time	double	Time when the data is discarded and this message is exported.
Port	String	Path of the port where unwanted data arrives at the component.
Data	Object	Data being discarded.
Description	Object	Explanation regarding this discarding.
Displayable	boolean	True if this garbage message is allowed to be displayed on an instrument component with a display.

Nested Class Summary

static class

GarbageContract.Message

Field Summary

static GarbageContract

INSTANCE

Fields inherited from class drcl.comp.Contract

Role_INITIATOR, Role_PEER, Role_REACTOR

Constructor Summary

GarbageContract()

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

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

Field Detail

INSTANCE

public static final GarbageContract INSTANCE

Constructor Detail

GarbageContract

public GarbageContract()

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