PlatformCreatorBuilder Class¶
-
class
NXOpen.Routing.
PlatformCreatorBuilder
¶ Bases:
NXOpen.Builder
Builder for creating platform.
Create platform: Takes platform outer boundaries sketch, platform plate boundaries sketch, platform plates, stocks for external and internal frames. Grate orientation symbol display is optional. To create a new instance of this class, use
NXOpen.Routing.RouteManager.CreatePlatformCreatorBuilder()
New in version NX8.5.0.
Properties¶
Property | Description |
---|---|
ExternalFrameAnchorName | Returns or sets the external frame stock anchor |
ExternalStockSettings | Returns the external frame stock settings for stock assignment. |
GrateOrientationReference | Returns or sets the grate orientation reference |
GrateOrientationSymbolDisplay | Returns or sets the grate orientation symbol display |
GrateOrientationSymbolRefSelection | Returns the grate orientation symbol ref selection |
InternalFrameAnchorName | Returns or sets the internal frame stock anchor |
InternalStockSettings | Returns the internal stock settings for stock assignment. |
PlateBoundariesSelection | Returns the platform part boundaries section |
SelectOuterBoundary | Returns the platform outer boundary section |
Tag | Returns the Tag for this object. |
ThickenDirection | Returns or sets the thicken direction |
UseSameStock | Returns or sets the internal frame use same stock option |
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. |
GetPlateAppliedCharx | Gets the plate charx which is used for platform plate |
GetPlatePart | Gets the plate part which data is used for platform plate |
SetPlateAppliedCharx | Sets the plate charx which is used for platform plate |
SetPlatePart | Sets the plate part which data is used for plaform plate |
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
SpecifyPlate | The specify plate button callback |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
PlatformCreatorBuilderReferenceType Enumeration | The grate orientation symbol reference |
Property Detail¶
ExternalFrameAnchorName¶
-
PlatformCreatorBuilder.
ExternalFrameAnchorName
¶ Returns or sets the external frame stock anchor
-------------------------------------
Getter Method
Signature
ExternalFrameAnchorName
Returns: Return type: str New in version NX8.5.0.
License requirements: routing_platform (“Routing Platform”)
-------------------------------------
Setter Method
Signature
ExternalFrameAnchorName
Parameters: anchorName (str) – New in version NX8.5.0.
License requirements: routing_platform (“Routing Platform”)
ExternalStockSettings¶
-
PlatformCreatorBuilder.
ExternalStockSettings
¶ Returns the external frame stock settings for stock assignment.
-------------------------------------
Getter Method
Signature
ExternalStockSettings
Returns: Return type: NXOpen.Routing.PathStockBuilder
New in version NX8.5.0.
License requirements: routing_platform (“Routing Platform”)
GrateOrientationReference¶
-
PlatformCreatorBuilder.
GrateOrientationReference
¶ Returns or sets the grate orientation reference
-------------------------------------
Getter Method
Signature
GrateOrientationReference
Returns: Return type: NXOpen.Routing.PlatformCreatorBuilderReferenceType
New in version NX8.5.0.
License requirements: routing_platform (“Routing Platform”)
-------------------------------------
Setter Method
Signature
GrateOrientationReference
Parameters: grateOrientationReference ( NXOpen.Routing.PlatformCreatorBuilderReferenceType
) –New in version NX8.5.0.
License requirements: routing_platform (“Routing Platform”)
GrateOrientationSymbolDisplay¶
-
PlatformCreatorBuilder.
GrateOrientationSymbolDisplay
¶ Returns or sets the grate orientation symbol display
-------------------------------------
Getter Method
Signature
GrateOrientationSymbolDisplay
Returns: Return type: bool New in version NX8.5.0.
License requirements: routing_platform (“Routing Platform”)
-------------------------------------
Setter Method
Signature
GrateOrientationSymbolDisplay
Parameters: grateOrientationSymbolDisplay (bool) – New in version NX8.5.0.
License requirements: routing_platform (“Routing Platform”)
GrateOrientationSymbolRefSelection¶
-
PlatformCreatorBuilder.
GrateOrientationSymbolRefSelection
¶ Returns the grate orientation symbol ref selection
-------------------------------------
Getter Method
Signature
GrateOrientationSymbolRefSelection
Returns: Return type: NXOpen.SelectNXObject
New in version NX8.5.0.
License requirements: routing_platform (“Routing Platform”)
InternalFrameAnchorName¶
-
PlatformCreatorBuilder.
InternalFrameAnchorName
¶ Returns or sets the internal frame stock anchor
-------------------------------------
Getter Method
Signature
InternalFrameAnchorName
Returns: Return type: str New in version NX8.5.0.
License requirements: routing_platform (“Routing Platform”)
-------------------------------------
Setter Method
Signature
InternalFrameAnchorName
Parameters: anchorName (str) – New in version NX8.5.0.
License requirements: routing_platform (“Routing Platform”)
InternalStockSettings¶
-
PlatformCreatorBuilder.
InternalStockSettings
¶ Returns the internal stock settings for stock assignment.
-------------------------------------
Getter Method
Signature
InternalStockSettings
Returns: Return type: NXOpen.Routing.PathStockBuilder
New in version NX8.5.0.
License requirements: routing_platform (“Routing Platform”)
PlateBoundariesSelection¶
-
PlatformCreatorBuilder.
PlateBoundariesSelection
¶ Returns the platform part boundaries section
-------------------------------------
Getter Method
Signature
PlateBoundariesSelection
Returns: Return type: NXOpen.Section
New in version NX8.5.0.
License requirements: routing_platform (“Routing Platform”)
SelectOuterBoundary¶
-
PlatformCreatorBuilder.
SelectOuterBoundary
¶ Returns the platform outer boundary section
-------------------------------------
Getter Method
Signature
SelectOuterBoundary
Returns: Return type: NXOpen.Section
New in version NX8.5.0.
License requirements: routing_platform (“Routing Platform”)
ThickenDirection¶
-
PlatformCreatorBuilder.
ThickenDirection
¶ Returns or sets the thicken direction
-------------------------------------
Getter Method
Signature
ThickenDirection
Returns: Return type: bool New in version NX8.5.0.
License requirements: routing_platform (“Routing Platform”)
-------------------------------------
Setter Method
Signature
ThickenDirection
Parameters: thickenDirection (bool) – New in version NX8.5.0.
License requirements: routing_platform (“Routing Platform”)
UseSameStock¶
-
PlatformCreatorBuilder.
UseSameStock
¶ Returns or sets the internal frame use same stock option
-------------------------------------
Getter Method
Signature
UseSameStock
Returns: Return type: bool New in version NX8.5.0.
License requirements: routing_platform (“Routing Platform”)
-------------------------------------
Setter Method
Signature
UseSameStock
Parameters: internalFrameFlipStock (bool) – New in version NX8.5.0.
License requirements: routing_platform (“Routing Platform”)
Method Detail¶
GetPlateAppliedCharx¶
-
PlatformCreatorBuilder.
GetPlateAppliedCharx
¶ Gets the plate charx which is used for platform plate
Signature
GetPlateAppliedCharx()
Returns: Return type: NXOpen.Routing.CharacteristicList
New in version NX8.5.0.
License requirements: routing_platform (“Routing Platform”)
GetPlatePart¶
-
PlatformCreatorBuilder.
GetPlatePart
¶ Gets the plate part which data is used for platform plate
Signature
GetPlatePart()
Returns: Return type: NXOpen.Routing.CharacteristicList
New in version NX8.5.0.
License requirements: routing_platform (“Routing Platform”)
SetPlateAppliedCharx¶
-
PlatformCreatorBuilder.
SetPlateAppliedCharx
¶ Sets the plate charx which is used for platform plate
Signature
SetPlateAppliedCharx(appliedCharx)
Parameters: appliedCharx ( NXOpen.Routing.CharacteristicList
) –New in version NX8.5.0.
License requirements: routing_platform (“Routing Platform”)
SetPlatePart¶
-
PlatformCreatorBuilder.
SetPlatePart
¶ Sets the plate part which data is used for plaform plate
Signature
SetPlatePart(platePart)
Parameters: platePart ( NXOpen.Routing.CharacteristicList
) –New in version NX8.5.0.
License requirements: routing_platform (“Routing Platform”)
SpecifyPlate¶
-
PlatformCreatorBuilder.
SpecifyPlate
¶ The specify plate button callback
Signature
SpecifyPlate()
New in version NX8.5.0.
License requirements: routing_platform (“Routing Platform”)
Validate¶
-
PlatformCreatorBuilder.
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.