CreateNewComponentBuilder Class¶
-
class
NXOpen.Assemblies.
CreateNewComponentBuilder
¶ Bases:
NXOpen.Builder
Represents a
NXOpen.Assemblies.CreateNewComponentBuilder
builder class.Input to this class can be PSM facet objects.
To create a new instance of this class, use
NXOpen.Assemblies.AssemblyManager.CreateNewComponentBuilder()
Default values.
Property Value ComponentCam Target ComponentOrigin Wcs DefiningObjectsAdded 1 LayerNumber 1 LayerOption Original OriginalObjectsDeleted 1 ReferenceSet Model New in version NX6.0.0.
Properties¶
Property | Description |
---|---|
ComponentCam | Returns or sets the cam component cam type |
ComponentOrigin | Returns or sets the component origin |
DefiningObjectsAdded | Returns or sets the defining objects added toggle |
LayerNumber | Returns or sets the layer number |
LayerOption | Returns or sets the layer option |
NewComponentName | Returns or sets the new component name |
NewFile | Returns or sets the file new object is get and set |
ObjectForNewComponent | Returns the objects for select block |
OriginalObjectsDeleted | Returns or sets the original objects deleted |
ReferenceSet | Returns or sets the reference set |
ReferenceSetName | Returns or sets the reference set name. |
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. |
Enumerations¶
CreateNewComponentBuilderComponentCamType Enumeration | Set the origin type |
CreateNewComponentBuilderComponentLayerOptionType Enumeration | Set the layer option type |
CreateNewComponentBuilderComponentOriginType Enumeration | Set the cam component type |
CreateNewComponentBuilderComponentReferenceSetType Enumeration | Set the reference set |
Property Detail¶
ComponentCam¶
-
CreateNewComponentBuilder.
ComponentCam
¶ Returns or sets the cam component cam type
-------------------------------------
Getter Method
Signature
ComponentCam()
Returns: Return type: NXOpen.Assemblies.CreateNewComponentBuilderComponentCamType
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ComponentCam(componentCam)
Parameters: componentCam ( NXOpen.Assemblies.CreateNewComponentBuilderComponentCamType
) –New in version NX6.0.0.
License requirements: None.
ComponentOrigin¶
-
CreateNewComponentBuilder.
ComponentOrigin
¶ Returns or sets the component origin
-------------------------------------
Getter Method
Signature
ComponentOrigin()
Returns: Return type: NXOpen.Assemblies.CreateNewComponentBuilderComponentOriginType
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ComponentOrigin(componentOrigin)
Parameters: componentOrigin ( NXOpen.Assemblies.CreateNewComponentBuilderComponentOriginType
) –New in version NX6.0.0.
License requirements: assemblies (“ASSEMBLIES MODULE”)
DefiningObjectsAdded¶
-
CreateNewComponentBuilder.
DefiningObjectsAdded
¶ Returns or sets the defining objects added toggle
-------------------------------------
Getter Method
Signature
DefiningObjectsAdded()
Returns: Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DefiningObjectsAdded(definingObjectsAdded)
Parameters: definingObjectsAdded (bool) – New in version NX6.0.0.
License requirements: assemblies (“ASSEMBLIES MODULE”)
LayerNumber¶
-
CreateNewComponentBuilder.
LayerNumber
¶ Returns or sets the layer number
-------------------------------------
Getter Method
Signature
LayerNumber()
Returns: Return type: int New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
LayerNumber(layerNumber)
Parameters: layerNumber (int) – New in version NX6.0.0.
License requirements: assemblies (“ASSEMBLIES MODULE”)
LayerOption¶
-
CreateNewComponentBuilder.
LayerOption
¶ Returns or sets the layer option
-------------------------------------
Getter Method
Signature
LayerOption()
Returns: Return type: NXOpen.Assemblies.CreateNewComponentBuilderComponentLayerOptionType
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
LayerOption(layerOption)
Parameters: layerOption ( NXOpen.Assemblies.CreateNewComponentBuilderComponentLayerOptionType
) –New in version NX6.0.0.
License requirements: assemblies (“ASSEMBLIES MODULE”)
NewComponentName¶
-
CreateNewComponentBuilder.
NewComponentName
¶ Returns or sets the new component name
-------------------------------------
Getter Method
Signature
NewComponentName()
Returns: Return type: str New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
NewComponentName(newComponentName)
Parameters: newComponentName (str) – New in version NX6.0.0.
License requirements: assemblies (“ASSEMBLIES MODULE”)
NewFile¶
-
CreateNewComponentBuilder.
NewFile
¶ Returns or sets the file new object is get and set
-------------------------------------
Getter Method
Signature
NewFile()
Returns: Return type: NXOpen.FileNew
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
NewFile(fileNew)
Parameters: fileNew ( NXOpen.FileNew
) –New in version NX6.0.0.
License requirements: assemblies (“ASSEMBLIES MODULE”)
ObjectForNewComponent¶
-
CreateNewComponentBuilder.
ObjectForNewComponent
¶ Returns the objects for select block
-------------------------------------
Getter Method
Signature
ObjectForNewComponent()
Returns: Return type: NXOpen.SelectDisplayableObjectList
New in version NX6.0.0.
License requirements: None.
OriginalObjectsDeleted¶
-
CreateNewComponentBuilder.
OriginalObjectsDeleted
¶ Returns or sets the original objects deleted
-------------------------------------
Getter Method
Signature
OriginalObjectsDeleted()
Returns: Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
OriginalObjectsDeleted(originalObjectsDeleted)
Parameters: originalObjectsDeleted (bool) – New in version NX6.0.0.
License requirements: assemblies (“ASSEMBLIES MODULE”)
ReferenceSet¶
-
CreateNewComponentBuilder.
ReferenceSet
¶ Returns or sets the reference set
-------------------------------------
Getter Method
Signature
ReferenceSet()
Returns: Get the reference set Return type: NXOpen.Assemblies.CreateNewComponentBuilderComponentReferenceSetType
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ReferenceSet(referenceSet)
Parameters: referenceSet ( NXOpen.Assemblies.CreateNewComponentBuilderComponentReferenceSetType
) – Get the reference setNew in version NX6.0.0.
License requirements: assemblies (“ASSEMBLIES MODULE”)
ReferenceSetName¶
-
CreateNewComponentBuilder.
ReferenceSetName
¶ Returns or sets the reference set name.
This should be used when reference set type is set to other
-------------------------------------
Getter Method
Signature
ReferenceSetName()
Returns: Return type: str New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ReferenceSetName(referenceSetName)
Parameters: referenceSetName (str) – New in version NX6.0.0.
License requirements: assemblies (“ASSEMBLIES MODULE”)
Method Detail¶
Validate¶
-
CreateNewComponentBuilder.
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.