@Role

Description

If the @Role annotation is not provided, the default Role.VARIABLE it is assumed.

Synopsis

• Role.PARAMETER
• Role.VARIABLE
• Role.SIMULATED
• Role.OBSERVED
• Role.STATE
• Role.OUTPUT

Type

Scope

Example

!  @Description("CSMLite Plant Component")
...
!  @Execute
SUBROUTINE Plant

    USE, INTRINSIC :: ISO_C_BINDING
    IMPLICIT NONE

!  @Description("Daily maximum temperature in degrees Centigrade")
!  @Role(Role.VARIABLE)
!  @In
   REAL(C_FLOAT) :: TMAX
!  @Description("Day of Year")
!  @In
   INTEGER(C_INT) :: DOY
!  @Description("Dynamic Control Variable")
!  @In
   CHARACTER(kind = C_CHAR, len = 5) : DYN
...
!  @Description("Leaf Area Index")
!  @Role(Role.OUTPUT)
!  @Out
   REAL(C_FLOAT) :: LAI
...

Java example:

@Role(Role.PARAMETER)
@In public double latitude;
This example tags 'latitude' as Parameter.

@Role(Role.OUTPUT_FILE + Role.PARAMETER)
@In public File input;
Roles can be combined too. Now the 'input' field is a parameter and an output file.