ProxyObjectParameterBuilder Class¶
-
class
NXOpen.Mechatronics.
ProxyObjectParameterBuilder
¶ Bases:
NXOpen.Builder
Represents a
NXOpen.Mechatronics.ProxyObjectParameterBuilder
.To create a new instance of this class, use
NXOpen.Mechatronics.ProxyObjectCollection.CreateProxyObjectParameterBuilder
New in version NX8.5.0.
Properties¶
Property | Description |
---|---|
AttrName | Returns or sets the name of parameter attribute in proxy object |
AttrType | Returns or sets the data type of parameter attribute in proxy object |
BoolValue | Returns or sets the bool value of parameter attribute in proxy object |
IntValue | Returns or sets the int value of parameter attribute in proxy object |
ParamId | Returns or sets the maximum parameter id of parameter attribute in proxy object |
RealValue | Returns or sets the real value of parameter attribute in proxy object |
Tag | Returns the Tag for this object. |
Methods¶
Method | Description |
---|---|
Commit | Commits any edits that have been applied to the builder. |
Destroy | Deletes the builder, and cleans up any objects created by the builder. |
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit. |
GetObject | Returns the object currently being edited by this builder. |
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Property Detail¶
AttrName¶
-
ProxyObjectParameterBuilder.
AttrName
¶ Returns or sets the name of parameter attribute in proxy object
-------------------------------------
Getter Method
Signature
AttrName()
Returns: Return type: str New in version NX8.5.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
-------------------------------------
Setter Method
Signature
AttrName(name)
Parameters: name (str) – New in version NX8.5.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
AttrType¶
-
ProxyObjectParameterBuilder.
AttrType
¶ Returns or sets the data type of parameter attribute in proxy object
-------------------------------------
Getter Method
Signature
AttrType()
Returns: Return type: int New in version NX8.5.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
-------------------------------------
Setter Method
Signature
AttrType(type)
Parameters: type (int) – New in version NX8.5.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
BoolValue¶
-
ProxyObjectParameterBuilder.
BoolValue
¶ Returns or sets the bool value of parameter attribute in proxy object
-------------------------------------
Getter Method
Signature
BoolValue()
Returns: Return type: NXOpen.Expression
New in version NX8.5.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
-------------------------------------
Setter Method
Signature
BoolValue(boolValueExp)
Parameters: boolValueExp ( NXOpen.Expression
) –New in version NX8.5.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
IntValue¶
-
ProxyObjectParameterBuilder.
IntValue
¶ Returns or sets the int value of parameter attribute in proxy object
-------------------------------------
Getter Method
Signature
IntValue()
Returns: Return type: NXOpen.Expression
New in version NX8.5.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
-------------------------------------
Setter Method
Signature
IntValue(intValueExp)
Parameters: intValueExp ( NXOpen.Expression
) –New in version NX8.5.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
ParamId¶
-
ProxyObjectParameterBuilder.
ParamId
¶ Returns or sets the maximum parameter id of parameter attribute in proxy object
-------------------------------------
Getter Method
Signature
ParamId()
Returns: Return type: int New in version NX8.5.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
-------------------------------------
Setter Method
Signature
ParamId(paramId)
Parameters: paramId (int) – New in version NX8.5.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
RealValue¶
-
ProxyObjectParameterBuilder.
RealValue
¶ Returns or sets the real value of parameter attribute in proxy object
-------------------------------------
Getter Method
Signature
RealValue()
Returns: Return type: NXOpen.Expression
New in version NX8.5.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
-------------------------------------
Setter Method
Signature
RealValue(realValueExp)
Parameters: realValueExp ( NXOpen.Expression
) –New in version NX8.5.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
Method Detail¶
Validate¶
-
ProxyObjectParameterBuilder.
Validate
¶ Validate whether the inputs to the component are sufficient for commit to be called.
If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.
Signature
Validate()
Returns: Was self validation successful Return type: bool New in version NX3.0.1.
License requirements: None.