PenetrationCutoutBuilder Class¶
-
class
NXOpen.Features.ShipDesign.
PenetrationCutoutBuilder
¶ Bases:
NXOpen.Builder
Represents a
NXOpen.Features.ShipDesign.PenetrationRequest
builderTo create a new instance of this class, use
NXOpen.Features.ShipDesign.PenetrationRequestCollection.CreatePenetrationCutoutBuilder()
Default values.
Property Value CornerRadius.Value 0 CoutoutType Circular Diameter.Value 0 DirectionType PerpendiculartoStructure Height.Value 0 Offset.Value 0 Radius.Value 0 Width.Value 0 New in version NX8.0.0.
Properties¶
Property | Description |
---|---|
CornerRadius | Returns the corner radius expression |
CoutoutType | Returns or sets the coutout type |
Diameter | Returns the diameter expression |
DirectionType | Returns or sets the direction type |
Height | Returns the height expression |
HoleSubType | Returns or sets the hole sub-type |
HoleType | Returns or sets the hole type |
HorizontalDirection | Returns or sets the horizontal direction |
ModifiedSketch | Returns or sets the modified sketch |
Offset | Returns the offset expression |
Orientation | Returns or sets the orientation |
Radius | Returns the radius expression |
Sketch | Returns the sketch |
Tag | Returns the Tag for this object. |
Width | Returns the width expression |
Methods¶
Method | Description |
---|---|
AddNonIntersectedStructure | Adds nonintersected structures |
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. |
RemoveNonIntersectedStructures | Removes all nonintersected structures |
SetDialogType | Set the dialog type |
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¶
CornerRadius¶
-
PenetrationCutoutBuilder.
CornerRadius
¶ Returns the corner radius expression
-------------------------------------
Getter Method
Signature
CornerRadius()
Returns: Return type: NXOpen.Expression
New in version NX8.0.0.
License requirements: None.
CoutoutType¶
-
PenetrationCutoutBuilder.
CoutoutType
¶ Returns or sets the coutout type
-------------------------------------
Getter Method
Signature
CoutoutType()
Returns: Return type: NXOpen.Features.ShipDesign.PenetrationRequestCoutoutType
New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CoutoutType(enumCoutoutType)
Parameters: enumCoutoutType ( NXOpen.Features.ShipDesign.PenetrationRequestCoutoutType
) –New in version NX8.0.0.
License requirements: nx_penetration_mgmt (“Penetration Management”)
Diameter¶
-
PenetrationCutoutBuilder.
Diameter
¶ Returns the diameter expression
-------------------------------------
Getter Method
Signature
Diameter()
Returns: Return type: NXOpen.Expression
New in version NX8.0.0.
License requirements: None.
DirectionType¶
-
PenetrationCutoutBuilder.
DirectionType
¶ Returns or sets the direction type
-------------------------------------
Getter Method
Signature
DirectionType()
Returns: Return type: NXOpen.Features.ShipDesign.PenetrationRequestDirectionType
New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DirectionType(enumDirection)
Parameters: enumDirection ( NXOpen.Features.ShipDesign.PenetrationRequestDirectionType
) –New in version NX8.0.0.
License requirements: nx_penetration_mgmt (“Penetration Management”)
Height¶
-
PenetrationCutoutBuilder.
Height
¶ Returns the height expression
-------------------------------------
Getter Method
Signature
Height()
Returns: Return type: NXOpen.Expression
New in version NX8.0.0.
License requirements: None.
HoleSubType¶
-
PenetrationCutoutBuilder.
HoleSubType
¶ Returns or sets the hole sub-type
-------------------------------------
Getter Method
Signature
HoleSubType()
Returns: Return type: str New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
HoleSubType(stringHoleType)
Parameters: stringHoleType (str) – New in version NX8.5.0.
License requirements: nx_penetration_mgmt (“Penetration Management”)
HoleType¶
-
PenetrationCutoutBuilder.
HoleType
¶ Returns or sets the hole type
-------------------------------------
Getter Method
Signature
HoleType()
Returns: Return type: str New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
HoleType(stringHoleType)
Parameters: stringHoleType (str) – New in version NX8.5.0.
License requirements: nx_penetration_mgmt (“Penetration Management”)
HorizontalDirection¶
-
PenetrationCutoutBuilder.
HorizontalDirection
¶ Returns or sets the horizontal direction
-------------------------------------
Getter Method
Signature
HorizontalDirection()
Returns: Return type: NXOpen.Direction
New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
HorizontalDirection(vectorHorizontalDirection)
Parameters: vectorHorizontalDirection ( NXOpen.Direction
) –New in version NX8.0.0.
License requirements: nx_penetration_mgmt (“Penetration Management”)
ModifiedSketch¶
-
PenetrationCutoutBuilder.
ModifiedSketch
¶ Returns or sets the modified sketch
-------------------------------------
Getter Method
Signature
ModifiedSketch()
Returns: Return type: NXOpen.Sketch
New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ModifiedSketch(modifiedSketch)
Parameters: modifiedSketch ( NXOpen.Sketch
) –New in version NX8.5.0.
License requirements: nx_penetration_mgmt (“Penetration Management”)
Offset¶
-
PenetrationCutoutBuilder.
Offset
¶ Returns the offset expression
-------------------------------------
Getter Method
Signature
Offset()
Returns: Return type: NXOpen.Expression
New in version NX8.0.0.
License requirements: None.
Orientation¶
-
PenetrationCutoutBuilder.
Orientation
¶ Returns or sets the orientation
-------------------------------------
Getter Method
Signature
Orientation()
Returns: Return type: NXOpen.Direction
New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Orientation(vectorOrientation)
Parameters: vectorOrientation ( NXOpen.Direction
) –New in version NX8.0.0.
License requirements: nx_penetration_mgmt (“Penetration Management”)
Radius¶
-
PenetrationCutoutBuilder.
Radius
¶ Returns the radius expression
-------------------------------------
Getter Method
Signature
Radius()
Returns: Return type: NXOpen.Expression
New in version NX8.0.0.
License requirements: None.
Sketch¶
-
PenetrationCutoutBuilder.
Sketch
¶ Returns the sketch
-------------------------------------
Getter Method
Signature
Sketch()
Returns: Return type: NXOpen.Section
New in version NX8.0.0.
License requirements: None.
Width¶
-
PenetrationCutoutBuilder.
Width
¶ Returns the width expression
-------------------------------------
Getter Method
Signature
Width()
Returns: Return type: NXOpen.Expression
New in version NX8.0.0.
License requirements: None.
Method Detail¶
AddNonIntersectedStructure¶
-
PenetrationCutoutBuilder.
AddNonIntersectedStructure
¶ Adds nonintersected structures
Signature
AddNonIntersectedStructure(structure)
Parameters: structure ( NXOpen.Body
) –New in version NX8.5.0.
License requirements: nx_penetration_mgmt (“Penetration Management”)
RemoveNonIntersectedStructures¶
-
PenetrationCutoutBuilder.
RemoveNonIntersectedStructures
¶ Removes all nonintersected structures
Signature
RemoveNonIntersectedStructures()
New in version NX8.5.0.
License requirements: nx_penetration_mgmt (“Penetration Management”)
SetDialogType¶
-
PenetrationCutoutBuilder.
SetDialogType
¶ Set the dialog type
Signature
SetDialogType(dialogType)
Parameters: dialogType ( NXOpen.Features.ShipDesign.PenetrationRequestBuilderRequestDialogType
) –New in version NX8.5.0.
License requirements: nx_penetration_mgmt (“Penetration Management”)
Validate¶
-
PenetrationCutoutBuilder.
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.