ProxyObjectBuilder Class

class NXOpen.Mechatronics.ProxyObjectBuilder

Bases: NXOpen.Builder

Represents a NXOpen.Mechatronics.ProxyObjectBuilder.

To create a new instance of this class, use NXOpen.Mechatronics.ProxyObjectCollection.CreateProxyObjectBuilder()

New in version NX8.5.0.

Properties

Property	Description
BuilderType	Returns or sets the use type of this builder.
Context	Returns or sets the context part of the proxy object
MaxParamId	Returns or sets the maximum parameter id used in the proxy object
ParameterList	Returns the parameter data
ProxyObjectName	Returns or sets the name of the proxy object
SelectGeomObject	Returns the select geometry object that describes the proxy object
SelectPhysicsObject	Returns the select physics objects that are encapsulated in the proxy object
Tag	Returns the Tag for this object.
UseType	Returns or sets the use type used in the proxy 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.

Enumerations

ProxyObjectBuilderType Enumeration

the Builder types.

Property Detail

BuilderType

ProxyObjectBuilder.BuilderType

Returns or sets the use type of this builder.

-------------------------------------

Getter Method

Signature BuilderType

Returns: Return type:NXOpen.Mechatronics.ProxyObjectBuilderType

New in version NX9.0.2.

License requirements: None.

-------------------------------------

Setter Method

Signature BuilderType

Parameters:useType (NXOpen.Mechatronics.ProxyObjectBuilderType) –

New in version NX9.0.2.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

Context

ProxyObjectBuilder.Context

Returns or sets the context part of the proxy object

-------------------------------------

Getter Method

Signature Context

Returns: Return type:NXOpen.BasePart

New in version NX8.5.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

-------------------------------------

Setter Method

Signature Context

Parameters:context (NXOpen.BasePart) –

New in version NX8.5.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

MaxParamId

ProxyObjectBuilder.MaxParamId

Returns or sets the maximum parameter id used in the proxy object

-------------------------------------

Getter Method

Signature MaxParamId

Returns: Return type:int

New in version NX8.5.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

-------------------------------------

Setter Method

Signature MaxParamId

Parameters:paramId (int) –

New in version NX8.5.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

ParameterList

ProxyObjectBuilder.ParameterList

Returns the parameter data

-------------------------------------

Getter Method

Signature ParameterList

Returns: Return type:NXOpen.Mechatronics.ProxyObjectParameterBuilderList

New in version NX8.5.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

ProxyObjectName

ProxyObjectBuilder.ProxyObjectName

Returns or sets the name of the proxy object

-------------------------------------

Getter Method

Signature ProxyObjectName

Returns: Return type:str

New in version NX8.5.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

-------------------------------------

Setter Method

Signature ProxyObjectName

Parameters:proxyObjectName (str) –

New in version NX8.5.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

SelectGeomObject

ProxyObjectBuilder.SelectGeomObject

Returns the select geometry object that describes the proxy object

-------------------------------------

Getter Method

Signature SelectGeomObject

Returns: Return type:NXOpen.SelectNXObjectList

New in version NX8.5.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

SelectPhysicsObject

ProxyObjectBuilder.SelectPhysicsObject

Returns the select physics objects that are encapsulated in the proxy object

-------------------------------------

Getter Method

Signature SelectPhysicsObject

Returns: Return type:NXOpen.SelectNXObjectList

New in version NX8.5.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

UseType

ProxyObjectBuilder.UseType

Returns or sets the use type used in the proxy object.

Use NXOpen.Mechatronics.ProxyObjectBuilder.BuilderType`() instead.

-------------------------------------

Getter Method

Signature UseType

Returns: Return type:int

New in version NX8.5.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

-------------------------------------

Setter Method

Signature UseType

Parameters:useType (int) –

New in version NX8.5.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

Method Detail

Validate

ProxyObjectBuilder.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.