[SparForte][Banner]
[Top Main Menu] Intro | Tutorials | Reference | Packages | Examples | Contributors   [Back Page]      [Next Page]  

Enums Package

The SparForte built-in enums package provides subprograms to manipulate enumerated values or values.

GCC Ada Equivalent: enumerated attributes

  e := first( t )            e := last( t )            e := pred( e2 )      
  e := succ( e2 )
 
Help Command: Contents of the enums package

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

 
[Right Submenu]

 Summary

 arrays

 btree_io

 calendar

 cgi

 chains

 command_line

 db/ postgresql

 dbm

 directory_operations

 doubly_linked...

 dynamic_hash_...

 enums

 exceptions

 files

 gnat.cgi

 gnat.crc32

 hash_io

 lock_files

 memcache

 memcache.highread

 mysql

 mysqlm

 numerics

 os

 pen

 pen (OpenGL)

 records

 sound

 source_info

 stats

 strings

 System

 teams

 templates

 text_io

 units

[Back to Top] Back To Top [Small Forte Symbol]