![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
Function Enumeration_Representation_Clause_Aggregate
function Enumeration_Representation_Clause_Aggregate (Clause : in Asis.Representation_Clause) return Asis.Expression;Expanded Name Asis.Representation_Clauses-
.Enumeration_Representation_Clause_AggregateReturns the expression representing the enumeration representation associated with the specified clause.
Description
Enumeration representation clauses are defined by the following syntax:
Ada83 LRM 13.3, Ada95 LRM 13.4
enumeration_representation_clause ::=
for type_simple_name use aggregate;This function returns the aggregate for the specified enumeration representation clause.
Parameters
Clause : in Asis.Representation_Clause;Specifies the enumeration representation clause for which the aggregate expression should be returned. The clause must be of the following kinds:
Element_Kinds Representation_Clause_Kinds
A_Representation_Clause An_Enumeration_Representation_Clause
return Asis.Expression;
Element_Kinds Expression_Kinds
An_Expression An_Aggregate
The returned element is of the following kinds:
Errors
Asis_Inappropriate_Element is raised and Environment.Status is set to Value_Error if a parameter references a Library variable that is no longer open or a parameter is specified that is not appropriate for the query.
Examples
Cross-References
- function Associated_Enumeration_Type_Representation
- function Associated_Type
- function Enumeration_Representation_Clause_Type_Simple_Name
Function Enumeration_Representation_Clause_Type_Simple_Name
function Enumeration_Representation_Clause_Type_Simple_Name (Clause : in Asis.Representation_Clause) return Asis.Simple_Name;Expanded Name Asis.Representation_Clauses-
.Enumeration_Representation_Clause_Type_Simple-
_NameReturns the simple name associated with the specified enumeration representation clause.
Description
Enumeration representation clauses are defined by the following syntax:
Ada83 LRM 13.3, Ada95 LRM 13.4
enumeration_representation_clause ::=
for type_simple_name use aggregate;This function returns the type simple name for the specified enumeration representation clause.
Parameters
Clause : in Asis.Representation_Clause;Specifies the record representation clause for which the simple name should be returned. The clause must be of the following kinds:
Element_Kinds Representation_Clause_Kinds
A_Representation_Clause A_Record_Representation_Clause
return Asis.Simple_Name;
Element_Kinds Expression_Kinds
An_Expression A_Simple_Name
The returned element is of the following kinds:
Errors
Asis_Inappropriate_Element is raised and Environment.Status is set to Value_Error if a parameter references a Library variable that is no longer open or a parameter is specified that is not appropriate for the query.
Examples
Cross-References
- function Associated_Enumeration_Type_Representation
- function Associated_Type
- function Enumeration_Representation_Clause_Aggregate
Function Kind
function Kind (Clause : in Asis.Representation_Clause) return Asis.Representation_Clause_Kinds;Expanded Name Asis.Representation_Clauses.Kind
Returns the kind of representation clause associated with the specified clause.
Description
Representation clauses are defined by the following syntax:
Ada83 LRM 13.1, Ada95 LRM 13.1
representation_clause ::=
type_representation_clause | address_clausetype_representation_clause ::= length_clause
| enumeration_representation_clause
| record_representation_clauseThis function returns the kind of the specified representation clause.
If the specified clause is not a representation specification or is Asis.Nil_Element, Not_A_Representation_Clause is returned.
A_Representation_Clause elements are returned in a Declarative_Item_List by the following functions:
- Declarations.Private_Part_Declarative_Items
- Declarations.Task_Declaration_Declarative_Items
- Declarations.Visible_Part_Declarative_Items
- Statements.Declarative_Items
- Type_Definitions.Task_Type_Declarative_Items
Parameters
Clause : in Asis.Representation_Clause;Specifies the representation clause for which the kind should be returned. The clause must be of the following kind:
Element_Kinds
A_Representation_Clause
return Asis.Representation_Clause_Kinds;Returns the kind of the representation represented by the clause or Not_A_Representation if the clause is not a representation clause or is Asis.Nil_Element.
Errors
Asis_Inappropriate_Element is raised and Environment.Status is set to Value_Error if a parameter references a Library variable that is no longer open or a parameter is specified that is not appropriate for the query.
Examples
Cross-References
Related subprograms and types:
- type Representation_Clause_Kinds
- function Declarations.Private_Part_Declarative_Items
- function Declarations.Task_Declaration_Declarative_Items
- function Type_Definitions.Task_Type_Declarative_Items
- function Declarations.Visible_Part_Declarative_Items
- function Statements.Declarative_Items
- "Determining Representation Kind"
- Ada83 LRM 13.1, Ada95 LRM 13.1
Function Length_Clause_Attribute
function Length_Clause_Attribute (Clause : in Asis.Representation_Clause) return Asis.Expression;Expanded Name Asis.Representation_Clauses.Length_Clause_Attribute
Returns the length expression associated with the specified representation clause.
Description
Length clauses are defined by the following syntax:
Ada83 LRM 13.2, Ada95 LRM 13.3
length_clause ::=
for attribute use simple_expression;This function returns the attribute for the specified length clause.
Parameters
Clause : in Asis.Representation_Clause;Specifies the length representation clause for which the length should be returned. The clause must be of the following kinds:
Element_Kinds Representation_Clause_Kinds
A_Representation_Clause A_Length_Clause
return Asis.Expression;The returned element is of the following kinds:
Element_Kinds Expression_Kinds
An_Expression An_Attribute
Errors
Asis_Inappropriate_Element is raised and Environment.Status is set to Value_Error if a parameter references a Library variable that is no longer open or a parameter is specified that is not appropriate for the query.
Examples
Cross-References
- function Associated_Length_Clause_Representations
- function Associated_Type
- function Length_Clause_Attribute_Kind
- function Length_Clause_Simple_Expression
Function Length_Clause_Attribute_Kind
function Length_Clause_Attribute_Kind (Clause : in Asis.Representation_Clause) return Length_Clause_Attribute_Kinds;Expanded Name Asis.Representation_Clauses-
.Length_Clause_Attribute_KindReturns the kind of length clause represented by the specified representation clause.
Description
Length clauses are defined by the following syntax:
Ada83 LRM 13.2, Ada95 LRM 13.3
length_clause ::=
for attribute use simple_expression;Ada83 LRM 4.1.4, Ada95 LRM 4.1.4
attribute ::= prefix'attribute_designatorThis function returns the kind of attribute designator for the specified length clause.
If the specified clause does not represent a length clause, Not_A_Length_Clause is returned.
Parameters
Clause : in Asis.Representation_Clause;Specifies the length representation clause for which the list of associated length attributes should be returned. The clause must be of the following kinds:
Element_Kinds Representation_Clause_Kinds
A_Representation_Clause A_Length_Clause
return Length_Clause_Attribute_Kinds;Returns the kind of length clauses associated with the specified clause or Not_A_Length_Clause for all other elements.
Errors
Asis_Inappropriate_Element is raised and Environment.Status is set to Value_Error if a parameter references a Library variable that is no longer open or a parameter is specified that is not appropriate for the query.
Examples
Cross-References
Related subprograms and types:
- function Associated_Length_Clause_Representations
- function Associated_Type
- function Length_Clause_Attribute
- type Length_Clause_Attribute_Kinds
- function Length_Clause_Simple_Expression
Type Length_Clause_Attribute_Kinds
type Length_Clause_Attribute_Kinds is (...);Expanded Name Asis.Representation_Clauses-
.Length_Clause_Attribute_KindsDescribes the kinds of length clauses that are available.
Description
This type describes the kinds of length clauses that are
available.Enumerations
A_Collection_Storage_Size_AttributeIndicates that a clause is a collection storage-size attribute ('Storage_Size, Ada83 LRM 13.2(7), Ada95 LRM 13.3).
A_Size_AttributeIndicates that a clause is a size attribute ('Size, Ada83 LRM 13.2(4), Ada95 LRM 13.3).
A_Small_AttributeIndicates that a clause is a fixed-point small attribute declaration ('Small, Ada83 LRM 13.2(11), Ada95 LRM 13.3).
A_Task_Storage_Size_AttributeIndicates that a clause is a task storage-size attribute ('Storage-
_Size, Ada83 LRM 13.2(9), Ada95 LRM 13.3).
Not_A_Length_AttributeIndicates that a clause does not represent an attribute definition.
Cross-References
Function Length_Clause_Simple_Expression
function Length_Clause_Simple_Expression (Clause : in Asis.Representation_Clause) return Asis.Expression;Expanded Name Asis.Representation_Clauses-
.Length_Clause_Simple_ExpressionReturns the length expression associated with the specified representation clause.
Description
Length clauses are defined by the following syntax:
Ada83 LRM 13.2, Ada95 LRM 13.3
length_clause ::=
for attribute use simple_expression;This function returns the simple expression for the specified length clause.
Parameters
Clause : in Asis.Representation_Clause;Specifies the length representation clause for which the length expression should be returned. The clause must be of the following kinds:
Element_Kinds Representation_Clause_Kinds
A_Representation_Clause A_Length_Clause
return Asis.Expression;
Element_Kinds
An_Expression
The returned element is of the following kind:
Errors
Asis_Inappropriate_Element is raised and Environment.Status is set to Value_Error if a parameter references a Library variable that is no longer open or a parameter is specified that is not appropriate for the query.
Examples
Cross-References
- function Associated_Length_Clause_Representations
- function Associated_Type
- function Length_Clause_Attribute
- function Length_Clause_Attribute_Kind
- "Processing Length Clauses"
- Ada83 LRM 13.2, Ada95 LRM 13.3
Function Record_Representation_Clause_Alignment_Clause_Expression
function Record_Representation_Clause_Alignment_Clause_Expression (Clause : in Asis.Representation_Clause) return Asis.Expression;Expanded Name Asis.Representation_Clauses-
.Record_Representation_Clause_Alignment_Clause-
_ExpressionReturns the alignment clause expression associated with the specified representation clause.
Description
Record representation clauses are partially defined by the following syntax:
Ada83 LRM 13.4, Ada95 LRM 13.5.1
record_representation_clause ::=
for type_simple_name use
record [alignment_clause]
{component_clause}
end record;alignment_clause ::=
at mod static_simple_expression;This function returns the static simple expression for the specified record representation clause.
If the record representation clause does not include an at mod component, Asis.Nil_Element is returned.
If the record is discriminated, several of the static simple expressions can evaluate to the same value.
Parameters
Clause : in Asis.Representation_Clause;Specifies the record representation clause for which the alignment clause expression should be returned. The clause must be of the following kinds:
Element_Kinds Representation_Clause_Kinds
A_Representation_Clause A_Record_Representation_Clause
return Asis.Expression;
Element_Kinds
An_Expression
The returned element is of the following kind:
Errors
Asis_Inappropriate_Element is raised and Environment.Status is set to Value_Error if a parameter references a Library variable that is no longer open or a parameter is specified that is not appropriate for the query.
Examples
Cross-References
- function Associated_Record_Type_Representation
- function Associated_Type
- function Record_Representation_Clause_Alignment_Clause_Pragmas
- function Record_Representation_Clause_Type_Simple_Name
Function Record_Representation_Clause_Alignment_Clause_Pragmas
function Record_Representation_Clause_Alignment_Clause_Pragmas (Clause : in Asis.Representation_Clause) return Asis.Element_List;Expanded Name Asis.Representation_Clauses-
.Record_Representation_Clause_Alignment_Clause-
_PragmasReturns a list of the pragmas that preceded the reserved words (or in place of) at mod that begin the alignment expression for the specified record representation clause.
Description
Record representation clauses are partially defined by the following syntax:
Ada83 LRM 13.4, Ada95 LRM 13.5.1
record_representation_clause ::=
for type_simple_name use
record [alignment_clause]
{component_clause}
end record;alignment_clause ::=
at mod static_simple_expression;Because of the Ada definition, it is possible to include a pragma before or in place of the at mod clause. This function returns the pragmas defined at that location.
If no pragmas appear before or in place of the alignment clause, Asis.Nil_Element_List is returned.
Parameters
Clause : in Asis.Representation_Clause;Specifies the record representation clause for which the alignment pragmas should be returned. The clause must be of the following kinds:
Element_Kinds Representation_Clause_Kinds
A_Representation_Clause A_Record_Representation_Clause
return Asis.Element_List;The returned list contains elements of the following kind:
Element_Kinds
A_Pragma
Errors
Asis_Inappropriate_Element is raised and Environment.Status is set to Value_Error if a parameter references a Library variable that is no longer open or a parameter is specified that is not appropriate for the query.
Examples
Cross-References
- function Associated_Record_Type_Representation
- function Associated_Type
- function Record_Representation_Clause_Alignment_Clause_Expression
- function Record_Representation_Clause_Type_Simple_Name
Function Record_Representation_Clause_Type_Simple_Name
function Record_Representation_Clause_Type_Simple_Name (Clause : in Asis.Representation_Clause) return Asis.Simple_Name;Expanded Name Asis.Representation_Clauses-
.Record_Representation_Clause_Type_Simple_NameReturns the simple name associated with the specified record representation clause.
Description
Record representation clauses are partially defined by the following syntax:
Ada83 LRM 13.4, Ada95 LRM 13.5.1
record_representation_clause ::=
for type_simple_name use
record [alignment_clause]
{component_clause}
end record;This function returns the type simple name from the specified record representation clause.
Parameters
Clause : in Asis.Representation_Clause;Specifies the record representation clause for which the simple name should be returned. The clause must be of the following kinds:
Element_Kinds Representation_Clause_Kinds
A_Representation_Clause A_Record_Representation_Clause
return Asis.Simple_Name;
Element_Kinds Expression_Kinds
An_Expression A_Simple_Name
The returned element is of the following kinds:
Errors
Asis_Inappropriate_Element is raised and Environment.Status is set to Value_Error if a parameter references a Library variable that is no longer open or a parameter is specified that is not appropriate for the query.
Examples
Cross-References
- function Associated_Record_Type_Representation
- function Associated_Type
- function Record_Representation_Clause_Alignment-
_Clause_Expression- function Record_Representation_Clause_Alignment-
_Clause_Pragmas
Type Representation_Clause_Kinds
type Representation_Clause_Kinds is (...);Expanded Name Asis.Representation_Clauses-
.Representation_Clause_KindsDescribes the kinds of representation clauses that are available.
Description
This type describes the kinds of representation clauses that are available.
Enumerations
An_Address_ClauseIndicates that the element represents an address clause (Ada83 LRM 13.5, Ada95 LRM 13.3).
An_Enumeration_Representation_ClauseIndicates that the element represents an enumeration representation clause (Ada83 LRM 13.3, Ada95 LRM 13.4).
A_Length_ClauseIndicates that the element represents a length clause (Ada83 LRM 13.2, Ada95 LRM 13.3).
A_Record_Representation_ClauseIndicates that the element represents a record representation clause (Ada83 LRM 13.4, Ada95 LRM 13.5.1).
Not_A_Representation_ClauseIndicates that the element does not represents a representation clause.
Cross-References
Package Operations
package Operations is -- For Length_Clause_Attribute_Kinds function "=" (Left, Right : ... -- For Representation_Clause_Kinds function "=" (Left, Right : ...end Operations;Expanded Name Asis.Representation_Clauses.Operations
Package Operations provides a simple way to obtain visibility to operators for types used in package Representation_Clauses. The package typically is referenced in a use clause by an
application.Cross-References
Rational Software Corporation
http://www.rational.com support@rational.com techpubs@rational.com Copyright © 1993-2001, Rational Software Corporation. All rights reserved. |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |