PenetrationAssociationBuilder Class¶
-
class
NXOpen.Features.ShipDesign.
PenetrationAssociationBuilder
¶ Bases:
NXOpen.Builder
Represents a
NXOpen.Features.ShipDesign.PenetrationAssociationBuilder
builderTo create a new instance of this class, use
NXOpen.Features.ShipDesign.PenetrationRequestCollection.CreatePenetrationAssociationBuilder()
New in version NX8.0.0.
Properties¶
Property | Description |
---|---|
CornerRadius | Returns the corner radius expression |
CoutoutType | Returns or sets the coutout type |
CutoutPart | Returns or sets the cutout part |
Diameter | Returns the diameter expression |
DirectionType | Returns or sets the direction |
Height | Returns the height expression |
IsEditMode | Returns or sets the flag to decide if it’s requests association or associated requests editing |
IsKeepAssociation | Returns or sets the flag to decide whether to keep association |
ModifiedSketch | Returns or sets the modified sketch |
Offset | Returns the offset expression |
Point | Returns or sets the penetration point |
Radius | Returns the radius expression |
SketchSection | Returns or sets the sketch |
Tag | Returns the Tag for this object. |
Width | Returns the width expression |
Methods¶
Method | Description |
---|---|
AddAdjacentStructure | Adds adjacent structures |
AddNonIntersectedStructure | Adds nonintersected structures |
AddRequest | Adds request object |
AddSelectedCurve | Adds selected curves |
ButtonCutout | Used to open the cutout dialog |
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 |
RemoveSelectedCurves | Removes all selected curves |
SetCompensationPartNumber | The selection compensation |
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¶
-
PenetrationAssociationBuilder.
CornerRadius
¶ Returns the corner radius expression
-------------------------------------
Getter Method
Signature
CornerRadius
Returns: Return type: NXOpen.Expression
New in version NX8.5.0.
License requirements: None.
CoutoutType¶
-
PenetrationAssociationBuilder.
CoutoutType
¶ Returns or sets the coutout type
-------------------------------------
Getter Method
Signature
CoutoutType
Returns: Return type: NXOpen.Features.ShipDesign.PenetrationRequestCoutoutType
New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CoutoutType
Parameters: enumCoutoutType ( NXOpen.Features.ShipDesign.PenetrationRequestCoutoutType
) –New in version NX8.5.0.
License requirements: nx_penetration_mgmt (“Penetration Management”)
CutoutPart¶
-
PenetrationAssociationBuilder.
CutoutPart
¶ Returns or sets the cutout part
-------------------------------------
Getter Method
Signature
CutoutPart
Returns: Return type: NXOpen.Part
New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CutoutPart
Parameters: cutoutPart ( NXOpen.Part
) –New in version NX8.5.0.
License requirements: nx_penetration_mgmt (“Penetration Management”)
Diameter¶
-
PenetrationAssociationBuilder.
Diameter
¶ Returns the diameter expression
-------------------------------------
Getter Method
Signature
Diameter
Returns: Return type: NXOpen.Expression
New in version NX8.5.0.
License requirements: None.
DirectionType¶
-
PenetrationAssociationBuilder.
DirectionType
¶ Returns or sets the direction
-------------------------------------
Getter Method
Signature
DirectionType
Returns: Return type: NXOpen.Features.ShipDesign.PenetrationRequestDirectionType
New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DirectionType
Parameters: enumDirection ( NXOpen.Features.ShipDesign.PenetrationRequestDirectionType
) –New in version NX8.5.0.
License requirements: nx_penetration_mgmt (“Penetration Management”)
Height¶
-
PenetrationAssociationBuilder.
Height
¶ Returns the height expression
-------------------------------------
Getter Method
Signature
Height
Returns: Return type: NXOpen.Expression
New in version NX8.5.0.
License requirements: None.
IsEditMode¶
-
PenetrationAssociationBuilder.
IsEditMode
¶ Returns or sets the flag to decide if it’s requests association or associated requests editing
-------------------------------------
Getter Method
Signature
IsEditMode
Returns: Return type: bool New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
IsEditMode
Parameters: isEditMode (bool) – New in version NX8.5.0.
License requirements: nx_penetration_mgmt (“Penetration Management”)
IsKeepAssociation¶
-
PenetrationAssociationBuilder.
IsKeepAssociation
¶ Returns or sets the flag to decide whether to keep association
-------------------------------------
Getter Method
Signature
IsKeepAssociation
Returns: Return type: bool New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
IsKeepAssociation
Parameters: isKeepAssociation (bool) – New in version NX8.5.0.
License requirements: nx_penetration_mgmt (“Penetration Management”)
ModifiedSketch¶
-
PenetrationAssociationBuilder.
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
Parameters: modifiedSketch ( NXOpen.Sketch
) –New in version NX8.5.0.
License requirements: nx_penetration_mgmt (“Penetration Management”)
Offset¶
-
PenetrationAssociationBuilder.
Offset
¶ Returns the offset expression
-------------------------------------
Getter Method
Signature
Offset
Returns: Return type: NXOpen.Expression
New in version NX8.5.0.
License requirements: None.
Point¶
-
PenetrationAssociationBuilder.
Point
¶ Returns or sets the penetration point
-------------------------------------
Getter Method
Signature
Point
Returns: Return type: NXOpen.Point
New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Point
Parameters: point ( NXOpen.Point
) –New in version NX8.0.0.
License requirements: nx_penetration_mgmt (“Penetration Management”)
Radius¶
-
PenetrationAssociationBuilder.
Radius
¶ Returns the radius expression
-------------------------------------
Getter Method
Signature
Radius
Returns: Return type: NXOpen.Expression
New in version NX8.5.0.
License requirements: None.
SketchSection¶
-
PenetrationAssociationBuilder.
SketchSection
¶ Returns or sets the sketch
-------------------------------------
Getter Method
Signature
SketchSection
Returns: Return type: NXOpen.Section
New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SketchSection
Parameters: sectionSketch ( NXOpen.Section
) –New in version NX8.5.0.
License requirements: nx_penetration_mgmt (“Penetration Management”)
Width¶
-
PenetrationAssociationBuilder.
Width
¶ Returns the width expression
-------------------------------------
Getter Method
Signature
Width
Returns: Return type: NXOpen.Expression
New in version NX8.5.0.
License requirements: None.
Method Detail¶
AddAdjacentStructure¶
-
PenetrationAssociationBuilder.
AddAdjacentStructure
¶ Adds adjacent structures
Signature
AddAdjacentStructure(adjacentStructure)
Parameters: adjacentStructure ( NXOpen.Body
) –New in version NX8.5.0.
License requirements: nx_penetration_mgmt (“Penetration Management”)
AddNonIntersectedStructure¶
-
PenetrationAssociationBuilder.
AddNonIntersectedStructure
¶ Adds nonintersected structures
Signature
AddNonIntersectedStructure(structure)
Parameters: structure ( NXOpen.Body
) –New in version NX8.5.0.
License requirements: nx_penetration_mgmt (“Penetration Management”)
AddRequest¶
-
PenetrationAssociationBuilder.
AddRequest
¶ Adds request object
Signature
AddRequest(request)
Parameters: request ( NXOpen.Features.ShipDesign.PenetrationRequest
) –New in version NX8.5.0.
License requirements: nx_penetration_mgmt (“Penetration Management”)
AddSelectedCurve¶
-
PenetrationAssociationBuilder.
AddSelectedCurve
¶ Adds selected curves
Signature
AddSelectedCurve(curve)
Parameters: curve ( NXOpen.Body
) –New in version NX8.5.0.
License requirements: nx_penetration_mgmt (“Penetration Management”)
ButtonCutout¶
-
PenetrationAssociationBuilder.
ButtonCutout
¶ Used to open the cutout dialog
Signature
ButtonCutout()
New in version NX8.0.0.
License requirements: nx_penetration_mgmt (“Penetration Management”)
RemoveNonIntersectedStructures¶
-
PenetrationAssociationBuilder.
RemoveNonIntersectedStructures
¶ Removes all nonintersected structures
Signature
RemoveNonIntersectedStructures()
New in version NX8.5.0.
License requirements: nx_penetration_mgmt (“Penetration Management”)
RemoveSelectedCurves¶
-
PenetrationAssociationBuilder.
RemoveSelectedCurves
¶ Removes all selected curves
Signature
RemoveSelectedCurves()
New in version NX8.5.0.
License requirements: nx_penetration_mgmt (“Penetration Management”)
SetCompensationPartNumber¶
-
PenetrationAssociationBuilder.
SetCompensationPartNumber
¶ The selection compensation
Signature
SetCompensationPartNumber(selectionCompensationNumber)
Parameters: selectionCompensationNumber (str) – New in version NX8.5.0.
License requirements: nx_penetration_mgmt (“Penetration Management”)
Validate¶
-
PenetrationAssociationBuilder.
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.