411 REFERENCE · Wikibooks
Ada Programming/Attributes/'Pos
Reference material by Wikibooks contributors. This retains its source identity and is not 411 news reporting.
Attributes 'Pos
__TOC__
Description
The 'Pos attribute is defined for all discrete types. It is a function returning the argument's position number as a universal_integer; the prefix S must be a subtype name.
(Universal integers are implicitly converted to any specific integer type as required by the context.)
function S'Pos (Arg: S'Base) return universal_integer;
For enumeration types, position numbers start at 0; if the argument does not denote a valid value (perhaps because of an uninitialized
variable), the exception Program_Error is raised.
For integer types, the attribute returns the value converted to universal_integer. Note that it is not necessary for the actual argument to belong to the subtype S.
Note that representation clauses do not affect position numbering. Whatever underlying value the enumerated value has, the position number will remain the same.
Example
I: Integer := -30;
Assert (Integer'Pos(I) = -30); of type universal_integer
type My_Enum is (Enum1, Enum2, Enum3);
for My_Enum use (Enum1 => 2, Enum2 => 4, Enum3 => 6);
...
Assert (My_Enum'Pos(Enum1) = 2); Wrong, 2 is the internal representation, not the position
Assert (My_Enum'Pos(Enum1) = 0); Right
Assert (My_Enum'Pos(Enum3) = 2);
subtype My_Enum_Sub is My_Enum range Enum1 .. Enum2;
Assert (My_Enum_Sub'Pos (Enum3) = 2); Enum3 does not belong to My_Enum_Sub
Another example without representation clause:
type Color is (Red, Blue, White);
Object : Color := White;
begin
Put (Color'Pos (Object)); -- prints 2, position of White.
...
See also
The inverse of the 'Pos attribute is 'Val.
The underlying representation can be obtained using an Unchecked_Conversion, or with the implementation-defined attribute 'Enum_Rep (GNAT).
For a detailed explanation of universal_integer, see Type System: Elaborated Discussion of Types for Signed Integer Types.
Wikibook
Ada Programming
Ada Programming/Attributes/'Val
Ada Programming/Attributes/'Valid
Ada Reference Manual
13 3 Operational and Representation Attributes
K Language-Defined Attributes
Pos