Library Object parameters

Library Designer
 can read data from an
Excel
 file to populate library parameters.
The parameter fields included in the
Excel
 file when creating an empty library object parameters file are:
Parameter
Description
:Library: Library Name
The name of the library object the parameter belongs to. Library Name must match an existing library object.
Param Name
The name of the parameter. This is a required field. It must be unique within the library scope.
Type
The data type of the parameter.
  • Bool
  • String
  • Int
  • Real
  • AxisID
Def Value
The default value for the parameter.
The value can be entered manually or generated by an expression.
Minimum
The minimum value for the parameter.
Required if the parameter data type is Int or Real.
The value can be entered manually or generated by an expression.
Maximum
The maximum value for the parameter.
Required if the parameter data type is Int or Real.
The value can be entered manually or generated by an expression.
ControlType
Determines the mode of user interaction with the parameter when the parameter is an immediate reference type.
  • TextBox
    . The parameter value is directly typed into a text box.
  • DropDownList
    . The parameter value is selected from a list of possible values.
ControlValues
Required when
DropDownList
 is specified as the
ControlType
. Defines the items included in the dropdown list from which the user can select. Enter options as a comma-separated string.
Group
The group in the Parameters tab where the parameter will appear. If the value entered matches an existing group name, the parameter will appear in this group. If the value entered does not match an existing group name, a new group will be created.
Ref Type
Determines whether the parameter is accessible to user input as an entry field, is populated automatically by a calculation, or references other parameters. The options are:
  • Immediate
    . Parameter is accessible to user input as an entry field.
  • Calculated
    . Parameter is not accessible to user input. The value is set to the name or description of the selected Parameter.
  • Reference
    . Parameter references an external reference. The parameter and the external reference function as a consumed and a produced tag. The parameter is linked to the external reference after instantiation. The
    Filter
     setting can be used to set criteria for the external reference.
ReadOnly
Set to
TRUE
 or
FALSE
. Determines whether the user will be able to enter values for the parameter in the
Application Code Manager
 application, or only read values that have been generated.
Disabled
Defines a condition that disables the parameter during instantiation. This field only affects parameters that are included in a subobject.
Auto Inc
Set to
TRUE
 or
FALSE
. When set to
TRUE
, the parameter will be populated automatically and the value incremented every time a new subobject is added to an ACM Project.
Linked Param
Select the parameter that this parameter is linked to from the list. The list of available parameters is composed of parameters within the library object where the
Ref Type
 is defined as
Reference
.
When the
Ref Type
 is set to
Calculated
, this parameter is required.
Linked Property
Select the property within the parameter that contains the value to use.
When the
Ref Type
 is set to
Calculated
, this parameter is required.
CLX Dependency
Set to
TRUE
 or
FALSE
. Determines whether the parameter is dependent upon a controller for it value.
Padding
Set to
TRUE
 or
FALSE
. When
TRUE
, single-digit integer values will be padded with zeros.
Filter
When
Reference
 has been specified as the
Ref Type
 for the parameter, use this field to create a filter expression to limit the external references.
UseCustom
When
Calculated
 has been specified as the
Ref Type
 for the parameter, use this field to specify a condition which, if true at instantiation, overrides the default and opens the field to user input.
Append
A text string that will be added to the end of the value of the parameter.
Visible
Defines a condition to control whether the parameter is displayed when the library object is added to an ACM Project.
Help
Help text to explain the function of the parameter and the result when specific values are entered. Appears at the bottom of the parameter window when the parameter is selected in the
Application Code Manager
 application.
Provide Feedback
Have questions or feedback about this documentation? Please submit your feedback here.
Normal