gov.sandia.cognition.annotation
Annotation Type ModelingApproximation


@CodeReview(reviewer="Kevin R. Dixon",
            date="2008-02-08",
            changesNeeded=false,
            comments="Interface looks fine.")
@Retention(value=RUNTIME)
@Documented
public @interface ModelingApproximation

The ModelingApproximation annotation indicates that an approximation is being used in modeling a component. It contains the person who originally made the approximation in the code, a description of the approximation, and a reference to a publication that provides the basis for the approximation.

Since:
2.0
Author:
Justin Basilico, Kevin R. Dixon, Zachary Benz

Required Element Summary
 String[] description
          A description of the approximation.
 String[] originator
          The full name originator who is making the approximation.
 PublicationReference[] reference
          A reference to a publication providing a basis for the modeling assumption.
 

Element Detail

originator

public abstract String[] originator
The full name originator who is making the approximation. For example, "Justin Basilico". This is the person to contact with questions about the approximation.

Returns:
The full name of the originator of the approximation.

description

public abstract String[] description
A description of the approximation.

Returns:
A description of the approximation.

reference

public abstract PublicationReference[] reference
A reference to a publication providing a basis for the modeling assumption.

Returns:
A reference to a publication providing the basis for the modeling assumption.