ObjectCreateBuilder Class

class NXOpen.PDM.ObjectCreateBuilder

Bases: NXOpen.Builder, NXOpen.IAttributeSourceObjectBuilder

Represents a builder class that perofrms create operation

To create a new instance of this class, use NXOpen.PDM.PdmSession.CreateObjectCreateBuilder()

New in version NX10.0.0.

Properties

Property Description
DefaultDestinationFolder Returns or sets the default destination folder string for the object being created.
Tag Returns the Tag for this object.

Methods

Method Description
AutoAssignAttributes Auto assigns the attributes for a given array of objects and returns an array of objects that failed to auto assign.
AutoAssignAttributesWithNamingPattern Auto assigns the attributes for a given object and returns an array of objects that failed to auto assign.
Commit Commits any edits that have been applied to the builder.
CreateAttributeTitleToNamingPatternMap Creates a map object of attribute titles to their corresponding naming pattern
CreateLogicalObjects Creates Pre-Creation LogicalObjects
Destroy Deletes the builder, and cleans up any objects created by the builder.
GetAttributeHolderObjects Returns an array of AttributeHolderObjects created as part of commit.
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.
SetTypes Set Types for which AttributeHolderObject needs to be created.
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

DefaultDestinationFolder

ObjectCreateBuilder.DefaultDestinationFolder

Returns or sets the default destination folder string for the object being created.

The default destination folder string can be <username>:<folder>:<folder>, or :<folder>:<folder> means username is optional. In case of :<folder>:<folder>, the first : indicates Home, for example, :Newstuff, is the Newstuff folder in current user’s Home container.

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

Getter Method

Signature DefaultDestinationFolder

Returns:
Return type:str

New in version NX10.0.0.

License requirements: None.

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

Setter Method

Signature DefaultDestinationFolder

Parameters:defaultDestinationFolder (str) –

New in version NX10.0.0.

License requirements: None.

Method Detail

AutoAssignAttributes

ObjectCreateBuilder.AutoAssignAttributes

Auto assigns the attributes for a given array of objects and returns an array of objects that failed to auto assign.

Signature AutoAssignAttributes(objects)

Parameters:objects (list of NXOpen.NXObject) –
Returns:
Return type:NXOpen.ErrorList

New in version NX8.5.0.

License requirements: None.

AutoAssignAttributesWithNamingPattern

ObjectCreateBuilder.AutoAssignAttributesWithNamingPattern

Auto assigns the attributes for a given object and returns an array of objects that failed to auto assign.

properties needs to be created using CreateAttributeTitleToNamingPatternMap()

Signature AutoAssignAttributesWithNamingPattern(objects, properties)

Parameters:
Returns:
Return type:

NXOpen.ErrorList

New in version NX12.0.0.

License requirements: None.

CreateAttributeTitleToNamingPatternMap

ObjectCreateBuilder.CreateAttributeTitleToNamingPatternMap

Creates a map object of attribute titles to their corresponding naming pattern

Signature CreateAttributeTitleToNamingPatternMap(attributeTitles, titlePatterns)

Parameters:
  • attributeTitles (list of str) –
  • titlePatterns (list of str) –
Returns:
Return type:

NXOpen.NXObject

New in version NX12.0.0.

License requirements: None.

CreateLogicalObjects

ObjectCreateBuilder.CreateLogicalObjects

Creates Pre-Creation LogicalObjects

Signature CreateLogicalObjects()

Returns:
Return type:list of NXOpen.PDM.LogicalObject

New in version NX10.0.0.

License requirements: None.

GetAttributeHolderObjects

ObjectCreateBuilder.GetAttributeHolderObjects

Returns an array of AttributeHolderObjects created as part of commit.

Signature GetAttributeHolderObjects()

Returns:
Return type:list of NXOpen.PDM.GenericObjectAttributeHolder

New in version NX10.0.0.

License requirements: None.

SetTypes

ObjectCreateBuilder.SetTypes

Set Types for which AttributeHolderObject needs to be created.

This method will remove all previously set types.

Signature SetTypes(tcTypes, baseTCTypes)

Parameters:
  • tcTypes (list of str) –
  • baseTCTypes (list of str) –

New in version NX10.0.0.

License requirements: None.

Validate

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