Adams Basic Package > Adams View > View Command Language > ude commands > ude create definition

ude create definition

Creates a User Defined Element (UDE) definition. UDE definition creation by default accompanied by the creation of default macros and dialog boxes as an easy interface to the user for creating instances. The autogenerated macro and dialog box creation is represented by an optional parameter, create_macros in command language and set to OFF by default.

Format:

 
ude create definition
definition_name =
a new UDE definition
isa =
an existing UDE definition
comments =
string
objects =
existing entity/entities
parameters =
existing design variable(s)
input_parameters =
design variable(s) of type object
output_parameters =
design variable(s) of type object
create_macro =
on / off
expose_contents =
on / off

Example:

 
ude create definition &
definition_name =
.my_ude_lib.ude_def_A &
isa =
.my_ude_lib.ude_def &
comments =
"this UDE represents a simple spring loaded actuator" &
objects =
.model_1.PART_2,.model_1.PART_3,.model_1.SFORCE_1 &
parameters =
.model_1.cyl_rho,.model_1.pist_rho,.model_1.stiffness &
input_parameters =
.model_1.cyl_attach_frame,.model_1.pist_attach_frame &
output_parameters =
.model_1.acutator_ref

Description:

 
Parameter
Value Type
Description
definition_name
a new UDE definition
Specifies the name of the UDE definition to be created; note that the name must also include the parent library in which the UDE definition will reside (UDE definitions are not children of models)
isa
an existing UDE definition
Specifies the name of an existing UDE definition in the same “class” as this new UDE definition. That is, UDE instances can only be replaced with UDE definitions that are of the same “class” (a grouping defined by this “isa” argument). Note that both the input and output parameters must match to be able to replace between UDE definitions.
comments
string
Specifies comments for the UDE definition being created
objects
existing entity/entities
Specifies the set of objects that make up the UDE definition
parameters
existing design variable(s)
Design variables used to control the parameterization of the UDE (spring stiffness for example)
input_parameters
design variable(s) of type object
Entities outside the UDE referenced by the UDE (typically a reference marker). The parameter itself is an object variable containing the marker reference.
output_parameters
design variable(s) of type object
Entities inside the UDE that should be accessible outside the UDE (often a marker that can be used as reference for another UDE or other entities). This parameter is an object variable containing the object that should be referenced.
create_macro
on / off
When set to "ON" Adams will automatically create the following supporting macros alongside the UDE definition: copy, create, dbox_display, modify, pre_delete and replace. Users who write their own macros should set create_macro to "OFF". If create_macro is not specified at all, then it will behave as though set to "OFF".
expose_contents
on / off
When set to ON, then instances of UDE definition will expose their constituent objects in the model browser.