Adams Basic Package > Adams View > View Command Language > interface > interface field create

interface field create

Allows you to create a new field menu.

A field is a space on a dialog box where a data elements can be entered and displayed.

Format:

interface field create
field_name =	A New GI_field
enabled =	Boolean
help_text =	String
documentation_text =	String
units =	Int_units
horiz_resizing =	Int_h_resize
vert_resizing =	Int_v_resize
location =	Real
height =	Real
width =	Real
preload_strings =	String
commands =	String
scrollable =	Boolean
editable =	Boolean
required =	Boolean
execute_cmds_on_exit=	Boolean
number_of_values=	Integer
string_type=	Str_type
add_quotes=	Add_quotes
object_type =	New_old_any
type_filter =	Ent
name_filter =	String
numeric_type =	Num_type
lower_check =	Low_check
lower_limit =	Real
upper_check =	Upp_check
upper_limit =	Real
file_type =	New_old_any
directory =	String
filter =	String
alert_on_overwrite =	Boolean
browse_action =	Open_save
word_wrap =	Boolean
spchars_allowed =	Boolean
unicode_allowed =	Boolean

Example:

interface field create &
field_name =	.gui.ATC.flde &
enabled =	yes &
help_text =	hlp_txt &
documentation_text =	doc_txt &
units =	relative &
horiz_resizing =	attach_left &
vert_resizing =	attach_top &
location =	0.1,0.1 &
height =	0.3 &
width =	0.3 &
preload_string =	predefined_txt_display &
commands =	"interface coord_window display=toggle" &
scrollable =	yes &
editable =	yes &
required =	yes &
execute_cmds_on_exit =	yes &
number_of_values =	1 &
string_type =	alpha_numeric &
add_quotes =	yes

Description:

Parameter	Value Type	Description
field _name	A New GI_field	Specifies the name of a new field
enabled	Boolean	Activates the field
help_text	String	Specifies the help text
documentation_text	String	Specifies the documentation text
units	Int_units	Specifies the field size as pixel or relative to Adams window
horiz_resizing	Int_h_resize	Specifies the attachment and scaling option for the filed
vert_resizing	Int_v_resize	Specifies the attachment and scaling option for the field
location	Real	Specifies the location of the field on the dialog box
height	Real	Specifies the height of the field in terms of relative units or pixel
width	Real	Specifies the width of the field in terms of relative units or pixel
preload strings	String	Specifies the initial text to be displayed
commands	String	Specifies the command to be executed after exiting the field
scrollable	Boolean	Specifies the scroll bar option of the field
editable	Boolean	Allows editing the field contents
required	Boolean	Specifies whether field is required or optional
execute_cmds_on_exit	Boolean	Sets the BOOLEAN parameter for execution of command after exiting field
number_of_values	Integer	Specifies the number of values allowed in the field
string_type add_quotes	Add_quotes	Specifies addition of quotes to the string
object_type	New_old_any	Specifies the object allowed in the field
type_filter	Ent	Specifies the types of objects allowed
name_filter	String	Specifies the name_filter for the object
numeric_type	Num_type	Specifies the type of numeric objects allowed
lower_check	Low_check	Specifies the applicability of lower check
lower_limit	Real	Specifies lower limit for lower check of numeric value
upper_check	Upp_check	Specifies the applicability of upper check
upper_limit	Real	Specifies upper limit for upper check of numeric value
file_type	New_old_any	Specifies the types of file allowed in the field
directory	String	Specifies the directory for the file
filter	String	Tests each value of the component
alert_on_overwrite	Boolean	Sets alert for file overwrite
browse_action	Open_save	Specifies if the button in the file browser window should be labelled "Open" or "Save".
word_wrap	Boolean	If set to "yes" text longer than the field width will wrap onto the next line. By default the behavior is as if this is set to "yes" and therefore text longer than the field width will remain on a single line and run beyond the field border.
spchars_allowed	Boolean	Default value is "no", the field will accept only alphanumeric characters and underscores. Spaces or other characters are not allowed.
unicode_allowed	Boolean	Default value is "no", the field will not allow unicode characters.

Extended Definition:

1. The field with specified name is created on the dialog box. If parameter ‘Enabled’ is set to ON, the field is be preactivated.

2. The pop-up help and documentation help can be specified in appropriate columns.

3. The size of the field can be specified either in terms of number of pixels. Alternatively, the size can also be stated as relative to the Adams window.

4. The vertical and horizontal resizing options are used to adjust the placement of the field menu on existing dialog box. For example, attach_left; attach_top options for Horiz_resizing and Vert_resizing will place the option menu on the top left corner of the dialog box. The location can also be specified from the top left corner by adjusting the parameter ‘location.’

5. The size of the field window can be specified with respect to the Adams window size. The value for parameter height and width should be a real number between 0.0 and 2.0, where 2.0 represents the height of the Adams View window. Therefore, a value of 1.0 will set the field window to be one half as high as the Adams View window.

6. The preload string is used to specify a predefined text to be displayed in the field. Thus a string ia preloaded in to the dialog box initially.

7. The parameter ‘command’ specifies the name of the command to be executed while exiting the field.

8. If the contents of the field do not fit the field window, then the field can be added with horizontal and vertical scrollbars making it ‘scrollable’. The contents of a field can be edited if the field is made ‘editable’ by choosing appropriate BOOLEAN value.

9. The execution of the associated command after exiting the window can be activated by setting the BOOLEAN option to ‘yes’. The number of values allowed in the field can be set by stating an integer value for the parameter ‘number_of_values’.

10. When specifying the objects for this operation a wild cards can be used, which may result in too many objects being found. For example, if all the parts for model MOD1 are desired, specifying .MOD1.* will get not only the parts, but all children of the model, like joints, forces, and so on. Using the parameter TYPE_FILTER=part will result in only the parts being processed by this command. Similarly, use of the NAME_FILTER will set the types of object allowed depending on the name of the object.

11. The numeric type of the object that is, integer, real or entering the node_id is allowed, where a check on the upper or lower limit of the numeric value can be set by choosing the upper and lower limits. This limit will filter the value above and below the specified value depending the parameter UPPER_CHECK and LOWER_CHECK.

12. The file type tobe read or written and its default directory can be chosen by specifying directory. if the ‘FILTER’ value is above the specified maximum value, or below the specified minimum value, set it to zero. For example: if the component is a discrete sampling of a sinusoidal wave with an amplitude of one (1), and filter is requested with a maximum value of .9 (above_value=.9), All the values of the corresponding to 'sin (x) > .9' will be set to 0.