SCL.AggregationDataTypes.LIST Class Reference
Public Member Functions | |
| def | bound_1 (self) |
| def | bound_2 (self) |
| def | get_hibound (self) |
| def | get_hiindex (self) |
| def | get_lobound (self) |
| def | get_loindex (self) |
| def | get_size (self) |
| def | get_value_unique (self) |
 Public Member Functions inherited from SCL.BaseType.Type | |
| def | get_scope (self) |
| def | get_type (self) |
Detailed Description
EXPRESS definition:
==================
A list data type has as its domain sequences of like elements. The optional lower and upper
bounds, which are integer-valued expressions, define the minimum and maximum number of
elements that can be held in the collection defined by a list data type.
A list data type
definition may optionally specify that a list value cannot contain duplicate elements.
Syntax:
237 list_type = LIST [ bound_spec ] OF [ UNIQUE ] base_type .
176 bound_spec = '[' bound_1 ':' bound_2 ']' .
174 bound_1 = numeric_expression .
175 bound_2 = numeric_expression .
171 base_type = aggregation_types | simple_types | named_types .
Rules and restrictions:
a) The bound_1 expression shall evaluate to an integer value greater than or equal to
zero. It gives the lower bound, which is the minimum number of elements that can be in a
list value of this data type. bound_1 shall not produce the indeterminate (?) value.
b) The bound_2 expression shall evaluate to an integer value greater than or equal to
bound_1, or an indeterminate (?) value. It gives the upper bound, which is the maximum
number of elements that can be in a list value of this data type.
If this value is indeterminate (?) the number of elements in a list value of this data type is
not bounded from above.
c) If the bound_spec is omitted, the limits are [0:?].
d) If the unique keyword is specified, each element in a list value of this data type shall
be different from (i.e., not instance equal to) every other element in the same list value.
EXAMPLE 28 { This example defines a list of arrays. The list can contain zero to ten arrays. Each
array of ten integers shall be different from all other arrays in a particular list.
complex_list : LIST[0:10] OF UNIQUE ARRAY[1:10] OF INTEGER;
Python definition:
==================
@TODO
Member Function Documentation
◆ bound_1()
| def SCL.AggregationDataTypes.LIST.bound_1 | ( | self | ) |
References SCL.AggregationDataTypes.ARRAY._bound_1, SCL.AggregationDataTypes.LIST._bound_1, SCL.AggregationDataTypes.BAG._bound_1, and SCL.AggregationDataTypes.SET._bound_1.
◆ bound_2()
| def SCL.AggregationDataTypes.LIST.bound_2 | ( | self | ) |
References SCL.AggregationDataTypes.ARRAY._bound_2, SCL.AggregationDataTypes.LIST._bound_2, SCL.AggregationDataTypes.BAG._bound_2, and SCL.AggregationDataTypes.SET._bound_2.
◆ get_hibound()
| def SCL.AggregationDataTypes.LIST.get_hibound | ( | self | ) |
References SCL.AggregationDataTypes.ARRAY._bound_2, SCL.AggregationDataTypes.LIST._bound_2, SCL.AggregationDataTypes.BAG._bound_2, and SCL.AggregationDataTypes.SET._bound_2.
◆ get_hiindex()
| def SCL.AggregationDataTypes.LIST.get_hiindex | ( | self | ) |
When V is a bag, list or set, the returned value is the actual number of elements in the aggregate value.
References SCL.AggregationDataTypes.ARRAY._container, SCL.AggregationDataTypes.LIST._container, SCL.AggregationDataTypes.BAG._container, and SCL.AggregationDataTypes.SET._container.
◆ get_lobound()
| def SCL.AggregationDataTypes.LIST.get_lobound | ( | self | ) |
References SCL.AggregationDataTypes.ARRAY._bound_1, SCL.AggregationDataTypes.LIST._bound_1, SCL.AggregationDataTypes.BAG._bound_1, and SCL.AggregationDataTypes.SET._bound_1.
◆ get_loindex()
| def SCL.AggregationDataTypes.LIST.get_loindex | ( | self | ) |
◆ get_size()
| def SCL.AggregationDataTypes.LIST.get_size | ( | self | ) |
References SCL.AggregationDataTypes.ARRAY._container, SCL.AggregationDataTypes.LIST._container, SCL.AggregationDataTypes.BAG._container, and SCL.AggregationDataTypes.SET._container.
Referenced by SCL.AggregationDataTypes.ARRAY.get_value_unique(), SCL.AggregationDataTypes.LIST.get_value_unique(), and SCL.AggregationDataTypes.BAG.get_value_unique().
◆ get_value_unique()
| def SCL.AggregationDataTypes.LIST.get_value_unique | ( | self | ) |
Return True if all items are different in the container, UNKNOWN if some items are indeterminate, or False otherwise
References SCL.AggregationDataTypes.ARRAY._bound_1, SCL.AggregationDataTypes.LIST._bound_1, SCL.AggregationDataTypes.BAG._bound_1, SCL.AggregationDataTypes.SET._bound_1, SCL.AggregationDataTypes.ARRAY._bound_2, SCL.AggregationDataTypes.LIST._bound_2, SCL.AggregationDataTypes.BAG._bound_2, SCL.AggregationDataTypes.SET._bound_2, SCL.AggregationDataTypes.ARRAY._container, SCL.AggregationDataTypes.LIST._container, SCL.AggregationDataTypes.BAG._container, SCL.AggregationDataTypes.SET._container, SCL.AggregationDataTypes.LIST._unbounded, SCL.AggregationDataTypes.BAG._unbounded, SCL.AggregationDataTypes.SET._unbounded, SCL.AggregationDataTypes.ARRAY._unique, SCL.AggregationDataTypes.LIST._unique, SCL.AggregationDataTypes.ARRAY.get_size(), SCL.AggregationDataTypes.LIST.get_size(), SCL.AggregationDataTypes.BAG.get_size(), SCL.AggregationDataTypes.SET.get_size(), and SCL.BaseType.Type.get_type().
The documentation for this class was generated from the following file:
- FreeCAD/src/Mod/Import/App/SCL/AggregationDataTypes.py
