ExportComponentHierarchyBuilder Class¶
-
class
NXOpen.Layout2d.
ExportComponentHierarchyBuilder
¶ Bases:
NXOpen.Builder
Represents a Builder for export component 2D hierarchy
To create a new instance of this class, use
NXOpen.Layout2d.ComponentCollection.CreateExportComponentHierarchyBuilder()
New in version NX11.0.0.
Properties¶
Property | Description |
---|---|
ChildComponentsForComponents | Returns or sets the flag indicating whether to export child components for components |
ChildComponentsForDefinitions | Returns or sets the flag indicating whether to export child components for definitions |
Contents | Returns or sets the flag indicating whether to export contents for components |
DefinitionReferenceProperties | Returns or sets the flag indicating whether to export definition reference properties for components |
Definitions | Returns or sets the flag indicating whether to export definitions for components |
OutputFileName | Returns or sets the selected output file |
Selection | Returns the selected objects which may be of NXOpen.Layout2d.Component or NXOpen.Sketch type |
SoftwareProperties | Returns or sets the flag indicating whether to export software properties for components |
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¶
ChildComponentsForComponents¶
-
ExportComponentHierarchyBuilder.
ChildComponentsForComponents
¶ Returns or sets the flag indicating whether to export child components for components
-------------------------------------
Getter Method
Signature
ChildComponentsForComponents()
Returns: Return type: bool New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ChildComponentsForComponents(childComponentsForComponents)
Parameters: childComponentsForComponents (bool) – New in version NX11.0.0.
License requirements: nx_layout (“NX Layout”)
ChildComponentsForDefinitions¶
-
ExportComponentHierarchyBuilder.
ChildComponentsForDefinitions
¶ Returns or sets the flag indicating whether to export child components for definitions
-------------------------------------
Getter Method
Signature
ChildComponentsForDefinitions()
Returns: Return type: bool New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ChildComponentsForDefinitions(childComponentsForDefinitions)
Parameters: childComponentsForDefinitions (bool) – New in version NX11.0.0.
License requirements: nx_layout (“NX Layout”)
Contents¶
-
ExportComponentHierarchyBuilder.
Contents
¶ Returns or sets the flag indicating whether to export contents for components
-------------------------------------
Getter Method
Signature
Contents()
Returns: Return type: bool New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Contents(contents)
Parameters: contents (bool) – New in version NX11.0.0.
License requirements: nx_layout (“NX Layout”)
DefinitionReferenceProperties¶
-
ExportComponentHierarchyBuilder.
DefinitionReferenceProperties
¶ Returns or sets the flag indicating whether to export definition reference properties for components
-------------------------------------
Getter Method
Signature
DefinitionReferenceProperties()
Returns: Return type: bool New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DefinitionReferenceProperties(definitionReferenceProperties)
Parameters: definitionReferenceProperties (bool) – New in version NX11.0.0.
License requirements: nx_layout (“NX Layout”)
Definitions¶
-
ExportComponentHierarchyBuilder.
Definitions
¶ Returns or sets the flag indicating whether to export definitions for components
-------------------------------------
Getter Method
Signature
Definitions()
Returns: Return type: bool New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Definitions(definitions)
Parameters: definitions (bool) – New in version NX11.0.0.
License requirements: nx_layout (“NX Layout”)
OutputFileName¶
-
ExportComponentHierarchyBuilder.
OutputFileName
¶ Returns or sets the selected output file
-------------------------------------
Getter Method
Signature
OutputFileName()
Returns: Return type: str New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
OutputFileName(outputFileName)
Parameters: outputFileName (str) – New in version NX11.0.0.
License requirements: nx_layout (“NX Layout”)
Selection¶
-
ExportComponentHierarchyBuilder.
Selection
¶ Returns the selected objects which may be of
NXOpen.Layout2d.Component
orNXOpen.Sketch
type-------------------------------------
Getter Method
Signature
Selection()
Returns: Return type: NXOpen.SelectDisplayableObjectList
New in version NX11.0.0.
License requirements: None.
SoftwareProperties¶
-
ExportComponentHierarchyBuilder.
SoftwareProperties
¶ Returns or sets the flag indicating whether to export software properties for components
-------------------------------------
Getter Method
Signature
SoftwareProperties()
Returns: Return type: bool New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SoftwareProperties(softwareProperties)
Parameters: softwareProperties (bool) – New in version NX11.0.0.
License requirements: nx_layout (“NX Layout”)
Method Detail¶
Validate¶
-
ExportComponentHierarchyBuilder.
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.