Tutorial User Guide > User Interface Functions > Inputs Box
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX''">XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX''">   
Inputs Box
AAUI.inputs_refresh
(input_id)
 
Description:
This function will display the required user input widgets in the Inputs Box and prepare the PCL function associated with input_id. This call is made automatically by the platform software when a new <dialog> is obtained.
Input:
STRING
input_id[32]
This value specifies the index id located in the function definitions file.
Output:
Error Conditions:
None.
Remarks:
The application author is not expected to make this call.
Example:
None
AAUI.inputs_applycb
()
 
Description:
This function will call the function referenced by the inputid index on the functions definitions text file. This call is made as part of the callback to the “Apply Inputs” button.
Input:
Output:
INTEGER
 
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
None.
Remarks:
The application author is not expected to make this call.
Example:
None.
AAUI.selectdatabox_read_raw
(num_select_databox, vstring)
Description:
This function will return the value in the specified select databox that is displayed in the UI form “Inputs” area.
Input:
INTEGER
num_select_databox
This value specifies which displayed select databox to read data from. 1 for the first select databox displayed, 2 for the second select databox displayed, etc.
Output:
STRING
vstring[VIRTUAL]
This value returns the data in the specified select databox. The memory is allocated with in this function.
INTEGER
 
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
None.
Remarks:
This is an auxiliary utility function that may be used inside of a custom PCL function that is called by the “Apply Inputs” action. This method of obtaining data is in addition to the normal call sequence argument value passing.
Example:
None.
AAUI.selectdatabox_read_ids
(num_select_databox, num_ids, ids)
Description:
This function will process data that is displayed in a select databox on the “Inputs” area of the UI form. It will return the ids of the entities selected. It is only supported for specific data types, like Point, Node, Element, Curve, Surface, Solid. Duplicate entries are eliminated.
Input:
INTEGER
num_select_databox
This value specifies the displayed select databox to read data from. 1 for the first select databox displayed, 2 for the second select databox displayed, etc.
Output:
INTEGER
num_ids
This value returns the number of id values returned.
INTEGER
ids(VIRTUAL)
This value returns the ids. The memory is allocated within this function.
INTEGER
 
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
None.
Remarks:
This is an auxiliary utility function that may be used inside of a custom PCL function that is called by the “Apply Inputs” action. This method of obtaining data is in addition to the normal call sequence argument value passing.
Example:
None.
AAUI.selectdatabox_read_coords
(num_select_databox, num, x_comp, y_comp, z_comp)
Description:
This function will process data that is displayed in a select databox on the “Inputs” area of the UI form. It will return the global coordinate positions for either Nodes or Points that were screen selected and displayed in a select databox.
Input:
INTEGER
num_select_databox
This value specifies the displayed select databox to read data from.1 for the first select databox displayed, 2 for the second select databox displayed, etc.
Output:
INTEGER
num
This value returns the number of coordinates returned.
REAL
x_comp(VIRTUAL)
This value returns the X coordinate values. The memory is allocated within this function.
REAL
y_comp(VIRTUAL)
This value returns the Y coordinate values. The memory is allocated within this function.
REAL
z_comp(VIRTUAL)
This value returns the Z coordinate values. The memory is allocated within this function.
INTEGER
 
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
None
Remarks:
This is an auxiliary utility function that may be used inside of a custom PCL function that is called by the “Apply Inputs” action. This method of obtaining data is in addition to the normal call sequence argument value passing.
Example:
None
AAUI.selectdatabox_assread_raw
(num_select_databox, entity, parent, entity_type, assoc_entities)
Description:
This function will return a list of all entities associated with the parent entities that were selected in the select databox.
Input:
INTEGER
num_select_databox
This value specifies the displayed select databox to read data from.1 for the first select databox displayed, 2 for the second select databox displayed, etc.
STRING
entity[]
This value specifies the desired entity type. The supported values are: “curve”, “elem”, “node”, “point” and “surface”.
STRING
parent[]
This value specifies the general type of entities contained by the select databox. The supported values are: “geo”, and “elem”.
INTEGER
entity_type
This value specifies the element shape to filter on when the entity is set to “elem”. Otherwise it is ignored. See the remarks below for more information.
Output:
STRING
assoc_entities[VIRTUAL]
This value returns a pick list of entities that match the given criteria.
INTEGER
 
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
None.
Remarks:
This is an auxiliary utility function that may be used inside of a custom PCL function that is called by the “Apply Inputs” action. This method of obtaining data is in addition to the normal call sequence argument value passing.
The input value entity_type controls which element type will be returned. This data is only used when the entity is set to “elem”. The following table identifies the entity type for each value.:
Value
Entity type
0
Any Element
1
Point Element
2
Beam Element
3
Tri Element
4
Quad Element
5
Tet Element
6
Wedge Element
7
(not used)
8
Hex Element
Example:
None
AAUI.selectdatabox_assread_ids
(num_select_databox, entity, parent, entity_type, num_ids, ids)
Description:
This function will return all the entity ids associated with the parent entities in the select databox.
Input:
INTEGER
num_select_databox
This value specifies the displayed select databox to read data from.1 for the first select databox displayed, 2 for the second select databox displayed, etc.
STRING
entity[]
This value specifies the desired entity type. The supported values are: “curve”, “elem”, “node”, “point” and “surface”.
STRING
parent[]
This value specifies the general type of entities contained by the select databox. The supported values are: “geo”, and “elem”.
INTEGER
entity_type
This value specifies the element shape to filter on when the entity is set to “elem”. Otherwise it is ignored. See the remarks below for more information.
Output:
INTEGER
num_ids
This value returns the number of id values returned.
INTEGER
ids(VITRUAL)
This value returns the ids. The memory is allocated within this function.
INTEGER
 
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
None.
Remarks:
This is an auxiliary utility function that may be used inside of a custom PCL function that is called by the “Apply Inputs” action. This method of obtaining data is in addition to the normal call sequence argument value passing.
The input value entity_type controls which element type will be returned. This data is only used when the entity is set to “elem”.
 
The following table identifies the entity type for each value:
Value
Entity type
0
Any Element
1
Point Element
2
Beam Element
3
Tri Element
4
Quad Element
5
Tet Element
6
Wedge Element
7
(not used)
8
Hex Element
Example:
None
AAUI.selectdatabox_assread_coords
(num_select_databox, entity, parent, num, x_comp, y_comp, z_comp)
Description:
This function will return the global coordinate positions for either nodes or points associated with parent entities in the specified select databox.
Input:
INTEGER
num_select_databox
This value specifies the displayed select databox to read data from.1 for the first select databox displayed, 2 for the second select databox displayed, etc.
STRING
entity[]
This value specifies the desired entity type. The supported values are: “node” or “point”.
STRING
parent[]
This value specifies the general type of entities contained by the select databox. The supported values are: “geo”, and “elem”.
Output:
INTEGER
num
This value returns the number of coordinates returned.
REAL
x_comp(VIRTUAL)
This value returns the X coordinate values. The memory is allocated within this function.
REAL
y_comp(VIRTUAL)
This value returns the Y coordinate values. The memory is allocated within this function.
REAL
z_comp(VIRTUAL)
This value returns the Z coordinate values. The memory is allocated within this function.
INTEGER
 
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
None.
Remarks:
This is an auxiliary utility function that may be used inside of a custom PCL function that is called by the “Apply Inputs” action. This method of obtaining data is in addition to the normal call sequence argument value passing.
Example:
None