DRCL JavaSim API

drcl.comp.contract
Class ErrorContract

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

public class ErrorContract
extends Contract

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

An error message is exported by a component when an error or a warning of processing arriving data occurs.

Specifically, an error message contains the following fields:
FIELD TYPE DESCRIPTION
Time double Time when this message is exported.
Port String Path of the port where the data arrives.
Data Object Data in process when the error is discovered.
Where String Name of the method in which the data is processed.
Description Object Description of this error.


Inner Class Summary
static class ErrorContract.Message
           
 
Field Summary
static ErrorContract INSTANCE
           
 
Fields inherited from class drcl.comp.Contract
Role_INITIATOR, Role_PEER, Role_REACTOR
 
Constructor Summary
ErrorContract()
           
 
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 ErrorContract INSTANCE
Constructor Detail

ErrorContract

public ErrorContract()
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

DRCL JavaSim API

Copyright © 2001 - DRCL, OSU     ~ Back to JavaSim Home ~