Enums Package
The SparForte built-in enums package provides subprograms to manipulate
enumerated values or values.
GCC Ada Equivalent: enumerated attributes
e := enums.first( t )
|
Return the first (lowest) item of the enumerated type. |
Example |
e := enums.first( boolean ); -- returns false |
Parameters |
Param |
Mode |
Type |
Default |
Description |
t |
in |
enumerated type |
required |
the enumerated type |
e |
return value |
enumerated item |
required |
the enumerated type's first item |
|
Exceptions |
- |
See Also |
- |
Compare With |
Ada: 'first attribute |
e := enums.last( t )
|
Return the last (highest) item of the enumerated type. |
Example |
e := enums.last( boolean ); -- returns true |
Parameters |
Param |
Mode |
Type |
Default |
Description |
t |
in |
enumerated type |
required |
the enumerated type |
e |
return value |
enumerated item |
required |
the enumerated type's last item |
|
Exceptions |
- |
See Also |
- |
Compare With |
Ada: 'last attribute |
e := enums.pred( e2 )
|
Return the previous (lower ordinal) item of the enumerated type. |
Example |
e := enums.pred( true ); -- returns false |
Parameters |
Param |
Mode |
Type |
Default |
Description |
e2 |
in |
enumerated item |
required |
the enumerated item |
e |
return value |
enumerated item |
required |
the enumerated item predecessor to e2 |
|
Exceptions |
- |
See Also |
- |
Compare With |
Ada: 'pred attribute |
e := enums.succ( e2 )
|
Return the successor (higher ordinal) item of the enumerated type. |
Example |
e := enums.succ( false ); -- returns true |
Parameters |
Param |
Mode |
Type |
Default |
Description |
e2 |
in |
enumerated item |
required |
the enumerated item |
e |
return value |
enumerated item |
required |
the enumerated item succssor to e2 |
|
Exceptions |
- |
See Also |
- |
Compare With |
Ada: 'succ attribute |
|