StepCreator Class¶
-
class
NXOpen.
StepCreator
¶ Bases:
NXOpen.DexBuilder
Represents a
NXOpen.StepCreator
to be used when exporting the STEP Data This class is created usingNXOpen.DexManager
.NULL object will be returned from Commit(). The workpart should be present in the session before calling commit(). To create a new instance of this class, use
NXOpen.DexManager.CreateStepCreator()
Default values.
Property Value BsplineTol 0.0254 ColorAndLayers 0 EntityNames LongName ExportAs Ap214 ExportExtRef 0 ExportExtRefStructureAs Basic ExportFrom DisplayPart ProcessHoldFlag 0 ValidationProperties 0 New in version NX11.0.0.
Properties¶
Property | Description |
---|---|
Author | Returns or sets the author |
Authorization | Returns or sets the authorization |
BsplineTol | Returns or sets the bspline tolerance |
ColorAndLayers | Returns or sets the color and layers - if set to true then NX color and layers will be preserverd |
Company | Returns or sets the company |
Description | Returns or sets the description |
EntityNames | Returns or sets the entity names types long or short |
ExportAs | Returns or sets the export as - this option will determine if data needs to be exported using AP203 or AP214 or AP242 |
ExportExtRef | Returns or sets the export ext ref - if set to true NX data can be output as external reference |
ExportExtRefStructureAs | Returns or sets the export ext ref as - specifiy the external reference Structure type |
ExportFrom | Returns or sets the export from - this option will determine if data from display part or existing part is exported |
ExportSelectionBlock | Returns the export selection block - the object selection will be done by this block. |
FileSaveFlag | Returns or sets the file save flag - set to false if doing file export |
InputFile | Returns or sets the input file - name of file which is being exported. |
LayerMask | Returns or sets the layerMask - You can limit the data you export by only specifying the layers that contain the appropriate information. |
ObjectTypes | Returns the objectTypes - this is subcomponent being used to set object types filters. |
OutputFile | Returns or sets the output file - the name of step file where output is being written |
ProcessHoldFlag | Returns or sets the process hold flag - set to true if user wants to wait until transaltion process gets completed |
SettingsFile | Returns or sets the Settings File to read the default settings |
Tag | Returns the Tag for this object. |
ValidationProperties | Returns or sets the validation properties - if set to true validation properties will be created |
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. |
SaveSettings | The save settings - this will save the settings to a file sepcified |
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¶
StepCreatorEntityNameOption Enumeration | Entity Name Option |
StepCreatorExportAsOption Enumeration | Export As option |
StepCreatorExportFromOption Enumeration | Create the builder |
StepCreatorExternalReferenceStructureOption Enumeration | External Reference Structure As Option |
Property Detail¶
Author¶
-
StepCreator.
Author
¶ Returns or sets the author
-------------------------------------
Getter Method
Signature
Author()
Returns: Return type: str New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Author(author)
Parameters: author (str) – New in version NX11.0.0.
License requirements: None.
Authorization¶
-
StepCreator.
Authorization
¶ Returns or sets the authorization
-------------------------------------
Getter Method
Signature
Authorization()
Returns: Return type: str New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Authorization(authorization)
Parameters: authorization (str) – New in version NX11.0.0.
License requirements: None.
BsplineTol¶
-
StepCreator.
BsplineTol
¶ Returns or sets the bspline tolerance
-------------------------------------
Getter Method
Signature
BsplineTol()
Returns: Return type: float New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
BsplineTol(bsplineTol)
Parameters: bsplineTol (float) – New in version NX11.0.0.
License requirements: None.
ColorAndLayers¶
-
StepCreator.
ColorAndLayers
¶ Returns or sets the color and layers - if set to true then NX color and layers will be preserverd
-------------------------------------
Getter Method
Signature
ColorAndLayers()
Returns: Return type: bool New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ColorAndLayers(colorAndLayers)
Parameters: colorAndLayers (bool) – New in version NX11.0.0.
License requirements: None.
Company¶
-
StepCreator.
Company
¶ Returns or sets the company
-------------------------------------
Getter Method
Signature
Company()
Returns: Return type: str New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Company(company)
Parameters: company (str) – New in version NX11.0.0.
License requirements: None.
Description¶
-
StepCreator.
Description
¶ Returns or sets the description
-------------------------------------
Getter Method
Signature
Description()
Returns: Return type: str New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Description(description)
Parameters: description (str) – New in version NX11.0.0.
License requirements: None.
EntityNames¶
-
StepCreator.
EntityNames
¶ Returns or sets the entity names types long or short
-------------------------------------
Getter Method
Signature
EntityNames()
Returns: Return type: NXOpen.StepCreatorEntityNameOption
New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
EntityNames(entityNames)
Parameters: entityNames ( NXOpen.StepCreatorEntityNameOption
) –New in version NX11.0.0.
License requirements: None.
ExportAs¶
-
StepCreator.
ExportAs
¶ Returns or sets the export as - this option will determine if data needs to be exported using AP203 or AP214 or AP242
-------------------------------------
Getter Method
Signature
ExportAs()
Returns: Return type: NXOpen.StepCreatorExportAsOption
New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ExportAs(exportAs)
Parameters: exportAs ( NXOpen.StepCreatorExportAsOption
) –New in version NX11.0.0.
License requirements: None.
ExportExtRef¶
-
StepCreator.
ExportExtRef
¶ Returns or sets the export ext ref - if set to true NX data can be output as external reference
-------------------------------------
Getter Method
Signature
ExportExtRef()
Returns: Return type: bool New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ExportExtRef(exportExtRef)
Parameters: exportExtRef (bool) – New in version NX11.0.0.
License requirements: None.
ExportExtRefStructureAs¶
-
StepCreator.
ExportExtRefStructureAs
¶ Returns or sets the export ext ref as - specifiy the external reference Structure type
-------------------------------------
Getter Method
Signature
ExportExtRefStructureAs()
Returns: Return type: NXOpen.StepCreatorExternalReferenceStructureOption
New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ExportExtRefStructureAs(exportExtRefStructureAs)
Parameters: exportExtRefStructureAs ( NXOpen.StepCreatorExternalReferenceStructureOption
) –New in version NX11.0.0.
License requirements: None.
ExportFrom¶
-
StepCreator.
ExportFrom
¶ Returns or sets the export from - this option will determine if data from display part or existing part is exported
-------------------------------------
Getter Method
Signature
ExportFrom()
Returns: Return type: NXOpen.StepCreatorExportFromOption
New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ExportFrom(exportFrom)
Parameters: exportFrom ( NXOpen.StepCreatorExportFromOption
) –New in version NX11.0.0.
License requirements: None.
ExportSelectionBlock¶
-
StepCreator.
ExportSelectionBlock
¶ Returns the export selection block - the object selection will be done by this block.
-------------------------------------
Getter Method
Signature
ExportSelectionBlock()
Returns: Return type: NXOpen.ObjectSelector
New in version NX11.0.0.
License requirements: None.
FileSaveFlag¶
-
StepCreator.
FileSaveFlag
¶ Returns or sets the file save flag - set to false if doing file export
-------------------------------------
Getter Method
Signature
FileSaveFlag()
Returns: Return type: bool New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
FileSaveFlag(doingFileSave)
Parameters: doingFileSave (bool) – New in version NX11.0.0.
License requirements: None.
InputFile¶
-
StepCreator.
InputFile
¶ Returns or sets the input file - name of file which is being exported.
-------------------------------------
Getter Method
Signature
InputFile()
Returns: Return type: str New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
InputFile(filename)
Parameters: filename (str) – New in version NX11.0.0.
License requirements: None.
LayerMask¶
-
StepCreator.
LayerMask
¶ Returns or sets the layerMask - You can limit the data you export by only specifying the layers that contain the appropriate information.
You can enter layer numbers or layers ranges separated by commas. For example, 1, 5, 88-109,190-199, 201, 206-210 is a legal specification. The default setting for Layers to Export is 1-256.
-------------------------------------
Getter Method
Signature
LayerMask()
Returns: Return type: str New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
LayerMask(layerMask)
Parameters: layerMask (str) – New in version NX11.0.0.
License requirements: None.
ObjectTypes¶
-
StepCreator.
ObjectTypes
¶ Returns the objectTypes - this is subcomponent being used to set object types filters.
This will be used to filter objects based on the types
-------------------------------------
Getter Method
Signature
ObjectTypes()
Returns: Return type: NXOpen.ObjectTypeSelector
New in version NX11.0.0.
License requirements: None.
OutputFile¶
-
StepCreator.
OutputFile
¶ Returns or sets the output file - the name of step file where output is being written
-------------------------------------
Getter Method
Signature
OutputFile()
Returns: Return type: str New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
OutputFile(filename)
Parameters: filename (str) – New in version NX11.0.0.
License requirements: None.
SettingsFile¶
-
StepCreator.
SettingsFile
¶ Returns or sets the Settings File to read the default settings
-------------------------------------
Getter Method
Signature
SettingsFile()
Returns: Return type: str New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SettingsFile(filename)
Parameters: filename (str) – New in version NX11.0.0.
License requirements: None.
ValidationProperties¶
-
StepCreator.
ValidationProperties
¶ Returns or sets the validation properties - if set to true validation properties will be created
-------------------------------------
Getter Method
Signature
ValidationProperties()
Returns: Return type: bool New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ValidationProperties(validationProperties)
Parameters: validationProperties (bool) – New in version NX11.0.0.
License requirements: None.
Method Detail¶
SaveSettings¶
-
StepCreator.
SaveSettings
¶ The save settings - this will save the settings to a file sepcified
Signature
SaveSettings(filename)
Parameters: filename (str) – New in version NX11.0.0.
License requirements: None.
Validate¶
-
StepCreator.
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.