Functions
- Last UpdatedNov 24, 2023
- 2 minute read
These functions deal with data extraction. All data possible to extract in User's Guide Data Extraction are available here as well.
This gives the ability to handle rules in Vitesse programs, since the surroundings of a construction can be investigated. It also gives the possibility to produce all kinds of listings, containing data from databases.
|
extract(dexstring) |
||
|
Perform data extraction. |
||
|
Input parameters: |
||
|
dexstring |
string |
string containing a valid data extraction statement. Please consult the User's Guide Data Extraction. |
|
Returned value: |
||
|
[0] |
integer |
Result: |
|
0 = success |
||
|
otherwise failure |
||
|
next_result() |
||
|
Activate the next result of a previously made data extraction. |
||
|
Returned value: |
||
|
[0] |
integer |
indicates the type of the result value |
|
= 0 empty tree part. |
||
|
= 1 integer type result |
||
|
= 2 real value type result. |
||
|
= 3 string type result. |
||
|
= 4 real vector 3D type result |
||
|
= 5 box type result |
||
|
= 6 real vector 2D type |
||
|
>10 real vector nD type. Subtracting 10 from the result gives the number of elements in the vector. |
||
|
= -1 End of result tree. |
||
|
get_commandstring() |
||
|
Get the data extraction command string for current result. |
||
|
Returned value: |
||
|
[0] |
string |
the command string |
|
get_int() |
||
|
Get current integer value. |
||
|
Returned value: |
||
|
[0] |
integer |
the integer value |
|
get_real() |
||
|
Get current real value. |
||
|
Returned value: |
||
|
[0] |
real |
the real value |
|
get_string() |
||
|
Get current string value. |
||
|
Returned value: |
||
|
[0] |
string |
the string value |
|
get_reavec3d() |
||
|
Get current real vector 3D |
||
|
Returned value: |
||
|
[0] |
real |
x value |
|
[1] |
real |
y value |
|
[2] |
real |
z value |
|
get_box() |
||
|
Get current box |
||
|
Returned value: |
||
|
[0] |
real |
x min |
|
[1] |
real |
y min |
|
[2] |
real |
z min |
|
[3] |
real |
x max |
|
[4] |
real |
y max |
|
[5] |
real |
z max |
|
get_reavec2d() |
||
|
Get current real vector 2D |
||
|
Returned value: |
||
|
[0] |
real |
x value |
|
[1] |
real |
y value |
|
get_indexedreal(index) |
||
|
Get value from current real vector nD. |
||
|
Input parameters: |
||
|
index |
integer |
index of wanted real |
|
Returned value: |
||
|
[0] |
real |
the real value |