ProfileCutoutBuilder Class¶
-
class
NXOpen.Features.ShipDesign.
ProfileCutoutBuilder
¶ Bases:
NXOpen.Features.FeatureBuilder
Represents a
NXOpen.Features.ShipDesign.ProfileCutout
builderTo create a new instance of this class, use
NXOpen.Features.ShipCollection.CreateProfileCutoutBuilder()
Default values.
Property Value AngularTolerance 0.5 DistanceTolerance 0.0254 (millimeters part), 0.001 (inches part) New in version NX8.0.0.
Properties¶
Property | Description |
---|---|
AngularTolerance | Returns or sets the angular tolerance (degrees). |
CollarPlateCreationApproach | Returns or sets the approach to be used in creating collar plate. |
CutoutData | Returns the sketch controlling the shape and parameters of the profile cutout. |
DistanceTolerance | Returns or sets the distance tolerance (part units). |
EnableCollarPlate | Returns or sets the flag to enable collar plate creation when creating profile cutout. |
EnableCornerCut | Returns or sets the flag to enable corner cut creation when creating profile cutout. |
ManufacturingInformation | Returns the manufacturing stock builder that holds the manufacturing data. |
ManufacturingStock | Returns the manufacturing stock builder that holds the manufacturing data. |
MoldingSideScallop | Returns the NXOpen.Features.ShipDesign.SteelFeatureSpreadsheetBuilder , which holds the information of the molding side scallop. |
OpposingSideScallop | Returns the NXOpen.Features.ShipDesign.SteelFeatureSpreadsheetBuilder , which holds the information of the opposing molding side scallop. |
ParametersInUserControl | Returns or sets the flag to indicate if the profile cutout detail parameters have been modified by user. |
ParentFeatureInternal | Returns or sets whether or not the latest timestamped parent feature of this feature should be made internal |
PatchSolutionFlag | Returns or sets the patch solution flag |
PatchSurfaceFilename | Returns or sets the patch surface filename |
ProfileBodies | Returns the profiles that are to have a cutout created for them. |
SectionTypesInUserControl | Returns or sets the flag to indicate if the section types have been modified by user. |
SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename |
Tag | Returns the Tag for this object. |
TargetObjects | Returns the plates that are to have cutouts placed into them for each profile. |
WeldCharacteristics | Returns the welding characteristics that will be attached to profile cuotut edges which have attribute MK_TYPE=WELD_EDGE. |
Methods¶
Method | Description |
---|---|
Commit | Commits any edits that have been applied to the builder. |
CommitFeature | Commits the feature parameters and creates the feature |
Destroy | Deletes the builder, and cleans up any objects created by the builder. |
EvaluateProfileCutoutParameters | Updates the parameters in profile cutout builder using parameters rules. |
FindOrientation | This method will find out the profile cutout orientation. |
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit. |
GetFeature | Returns the feature currently being edited by this builder. |
GetObject | Returns the object currently being edited by this builder. |
HideInternalParentFeatureAfterEdit | Re-suppress an internal parent feature (a slave feature) after it has been edited. |
RemoveSlaves | Temporarily removes profile cutout slave features when editing profile cutout in ship basic design to prevent the downstream features from updating. |
ResetContextEntity | Resets the section types acoording to the tightness attribute on the target and the context attribute on the profile |
SetDefaultScallopTypes | Set the default scallop types for the profile cutout builder. |
SetParentFeatureInternal | Set the parent features which would be internal or slaves to the feature being created or commited |
ShowInternalParentFeatureForEdit | Unsuppress an internal parent feature (a slave feature) so it can be edited. |
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
SynchronizeParametersWithProfileBody | Updates the parameters in profile cutout builder using profile body. |
UnsetParentFeatureInternal | Set the internal parent feature of the feature being edited to external |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
ProfileCutoutBuilderCollarPlateCreationApproaches Enumeration | Represents the collar plate creation approaches. |
ProfileCutoutBuilderOrientation Enumeration | Represents the profile cutout orientation values. |
Property Detail¶
AngularTolerance¶
-
ProfileCutoutBuilder.
AngularTolerance
¶ Returns or sets the angular tolerance (degrees).
-------------------------------------
Getter Method
Signature
AngularTolerance
Returns: Return type: float New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
AngularTolerance
Parameters: angularTolerance (float) – New in version NX8.0.0.
License requirements: nx_ship_basic (“Ship Basic Design”) OR nx_ship_detail (“Ship Detail Design”)
CollarPlateCreationApproach¶
-
ProfileCutoutBuilder.
CollarPlateCreationApproach
¶ Returns or sets the approach to be used in creating collar plate.
-------------------------------------
Getter Method
Signature
CollarPlateCreationApproach
Returns: Return type: NXOpen.Features.ShipDesign.ProfileCutoutBuilderCollarPlateCreationApproaches
New in version NX11.0.0.
License requirements: nx_ship_basic (“Ship Basic Design”) OR nx_ship_detail (“Ship Detail Design”)
-------------------------------------
Setter Method
Signature
CollarPlateCreationApproach
Parameters: collarPlateCreationApproach ( NXOpen.Features.ShipDesign.ProfileCutoutBuilderCollarPlateCreationApproaches
) –New in version NX11.0.0.
License requirements: nx_ship_basic (“Ship Basic Design”) OR nx_ship_detail (“Ship Detail Design”)
CutoutData¶
-
ProfileCutoutBuilder.
CutoutData
¶ Returns the sketch controlling the shape and parameters of the profile cutout.
The cutout sketch type and its parameters are controlled by the
NXOpen.Features.ShipDesign.SteelFeatureSpreadsheetBuilder
.-------------------------------------
Getter Method
Signature
CutoutData
Returns: Return type: NXOpen.Features.ShipDesign.SteelFeatureSpreadsheetBuilder
New in version NX8.0.0.
License requirements: None.
DistanceTolerance¶
-
ProfileCutoutBuilder.
DistanceTolerance
¶ Returns or sets the distance tolerance (part units).
-------------------------------------
Getter Method
Signature
DistanceTolerance
Returns: Return type: float New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DistanceTolerance
Parameters: distanceTolerance (float) – New in version NX8.0.0.
License requirements: nx_ship_basic (“Ship Basic Design”) OR nx_ship_detail (“Ship Detail Design”)
EnableCollarPlate¶
-
ProfileCutoutBuilder.
EnableCollarPlate
¶ Returns or sets the flag to enable collar plate creation when creating profile cutout.
-------------------------------------
Getter Method
Signature
EnableCollarPlate
Returns: Return type: bool New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
EnableCollarPlate
Parameters: enableCollarPlate (bool) – New in version NX9.0.0.
License requirements: nx_ship_basic (“Ship Basic Design”) OR nx_ship_detail (“Ship Detail Design”)
EnableCornerCut¶
-
ProfileCutoutBuilder.
EnableCornerCut
¶ Returns or sets the flag to enable corner cut creation when creating profile cutout.
-------------------------------------
Getter Method
Signature
EnableCornerCut
Returns: Return type: bool New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
EnableCornerCut
Parameters: bEnableCornerCut (bool) – New in version NX9.0.0.
License requirements: nx_ship_basic (“Ship Basic Design”) OR nx_ship_detail (“Ship Detail Design”)
ManufacturingInformation¶
-
ProfileCutoutBuilder.
ManufacturingInformation
¶ Returns the manufacturing stock builder that holds the manufacturing data.
-------------------------------------
Getter Method
Signature
ManufacturingInformation
Returns: Return type: NXOpen.Features.ShipDesign.ManufacturingStockBuilder
New in version NX8.5.1.
License requirements: None.
ManufacturingStock¶
-
ProfileCutoutBuilder.
ManufacturingStock
¶ Returns the manufacturing stock builder that holds the manufacturing data.
-------------------------------------
Getter Method
Signature
ManufacturingStock
Returns: Return type: NXOpen.Features.ShipDesign.ManufacturingStockBuilder
New in version NX8.5.0.
Deprecated since version NX8.5.1: Use
NXOpen.Features.ShipDesign.ProfileCutoutBuilder.ManufacturingInformation()
instead.License requirements: None.
MoldingSideScallop¶
-
ProfileCutoutBuilder.
MoldingSideScallop
¶ Returns the
NXOpen.Features.ShipDesign.SteelFeatureSpreadsheetBuilder
, which holds the information of the molding side scallop.-------------------------------------
Getter Method
Signature
MoldingSideScallop
Returns: Return type: NXOpen.Features.ShipDesign.SteelFeatureSpreadsheetBuilder
New in version NX9.0.0.
License requirements: None.
OpposingSideScallop¶
-
ProfileCutoutBuilder.
OpposingSideScallop
¶ Returns the
NXOpen.Features.ShipDesign.SteelFeatureSpreadsheetBuilder
, which holds the information of the opposing molding side scallop.-------------------------------------
Getter Method
Signature
OpposingSideScallop
Returns: Return type: NXOpen.Features.ShipDesign.SteelFeatureSpreadsheetBuilder
New in version NX9.0.0.
License requirements: None.
ParametersInUserControl¶
-
ProfileCutoutBuilder.
ParametersInUserControl
¶ Returns or sets the flag to indicate if the profile cutout detail parameters have been modified by user.
If it is true, it means the parameter values are specified by user and the rule driven process will not update the parameter values.
-------------------------------------
Getter Method
Signature
ParametersInUserControl
Returns: Return type: bool New in version NX9.0.1.
License requirements: nx_ship_basic (“Ship Basic Design”) OR nx_ship_detail (“Ship Detail Design”)
-------------------------------------
Setter Method
Signature
ParametersInUserControl
Parameters: bIsParametersInUserControl (bool) – New in version NX9.0.1.
License requirements: nx_ship_basic (“Ship Basic Design”) OR nx_ship_detail (“Ship Detail Design”)
ProfileBodies¶
-
ProfileCutoutBuilder.
ProfileBodies
¶ Returns the profiles that are to have a cutout created for them.
-------------------------------------
Getter Method
Signature
ProfileBodies
Returns: Return type: NXOpen.SelectDisplayableObjectList
New in version NX8.0.0.
License requirements: None.
SectionTypesInUserControl¶
-
ProfileCutoutBuilder.
SectionTypesInUserControl
¶ Returns or sets the flag to indicate if the section types have been modified by user.
If it is true, it means the section type is chosen by user and the rule driven process will not update the type.
-------------------------------------
Getter Method
Signature
SectionTypesInUserControl
Returns: Return type: bool New in version NX9.0.0.
License requirements: nx_ship_basic (“Ship Basic Design”) OR nx_ship_detail (“Ship Detail Design”)
-------------------------------------
Setter Method
Signature
SectionTypesInUserControl
Parameters: bIsSectionTypesInUserControl (bool) – New in version NX9.0.0.
License requirements: nx_ship_basic (“Ship Basic Design”) OR nx_ship_detail (“Ship Detail Design”)
TargetObjects¶
-
ProfileCutoutBuilder.
TargetObjects
¶ Returns the plates that are to have cutouts placed into them for each profile.
-------------------------------------
Getter Method
Signature
TargetObjects
Returns: Return type: NXOpen.SelectDisplayableObjectList
New in version NX8.0.0.
License requirements: None.
WeldCharacteristics¶
-
ProfileCutoutBuilder.
WeldCharacteristics
¶ Returns the welding characteristics that will be attached to profile cuotut edges which have attribute MK_TYPE=WELD_EDGE.
-------------------------------------
Getter Method
Signature
WeldCharacteristics
Returns: Return type: NXOpen.Weld.CharacteristicsBuilder
New in version NX9.0.0.
License requirements: None.
Method Detail¶
EvaluateProfileCutoutParameters¶
-
ProfileCutoutBuilder.
EvaluateProfileCutoutParameters
¶ Updates the parameters in profile cutout builder using parameters rules.
Signature
EvaluateProfileCutoutParameters(tgTargetBody, tgProfileBody)
Parameters: - tgTargetBody (
NXOpen.TaggedObject
) – - tgProfileBody (
NXOpen.TaggedObject
) –
New in version NX10.0.0.
License requirements: nx_ship_basic (“Ship Basic Design”) OR nx_ship_detail (“Ship Detail Design”)
- tgTargetBody (
FindOrientation¶
-
ProfileCutoutBuilder.
FindOrientation
¶ This method will find out the profile cutout orientation.
This information will be used for drawing automation to draw the profile cutout symbol, when the profile cutout was created by flip then the symbol should be drawn flip also. So this method can be used to indicate whether the profile cuotut was created by flip or not. The logic is: The target plate shuold have the start/end flag(by seeing the End cut face attributes) and the profile(profile cutout created based on)’s molding line face is more nearing to the start of the plate, then this method will return Normal, or Flipped. if the targe plate doens’t have any flag of start/end, then None will be returned.
Signature
FindOrientation()
Returns: Return type: NXOpen.Features.ShipDesign.ProfileCutoutBuilderOrientation
New in version NX8.5.0.
License requirements: nx_ship_basic (“Ship Basic Design”) OR nx_ship_detail (“Ship Detail Design”)
RemoveSlaves¶
-
ProfileCutoutBuilder.
RemoveSlaves
¶ Temporarily removes profile cutout slave features when editing profile cutout in ship basic design to prevent the downstream features from updating.
They will be restrored when committing the profile cutout builder.
Signature
RemoveSlaves()
New in version NX9.0.0.
License requirements: nx_ship_basic (“Ship Basic Design”)
ResetContextEntity¶
-
ProfileCutoutBuilder.
ResetContextEntity
¶ Resets the section types acoording to the tightness attribute on the target and the context attribute on the profile
Signature
ResetContextEntity(tgTargetBody, tgProfileBody)
Parameters: - tgTargetBody (
NXOpen.TaggedObject
) – - tgProfileBody (
NXOpen.TaggedObject
) –
New in version NX10.0.0.
License requirements: nx_ship_basic (“Ship Basic Design”) OR nx_ship_detail (“Ship Detail Design”)
- tgTargetBody (
SetDefaultScallopTypes¶
-
ProfileCutoutBuilder.
SetDefaultScallopTypes
¶ Set the default scallop types for the profile cutout builder.
Signature
SetDefaultScallopTypes(strProfileCutoutType)
Parameters: strProfileCutoutType (str) – New in version NX9.0.0.
License requirements: None.
SynchronizeParametersWithProfileBody¶
-
ProfileCutoutBuilder.
SynchronizeParametersWithProfileBody
¶ Updates the parameters in profile cutout builder using profile body.
Signature
SynchronizeParametersWithProfileBody(tgProfileBody)
Parameters: tgProfileBody ( NXOpen.TaggedObject
) –New in version NX10.0.3.
License requirements: nx_ship_basic (“Ship Basic Design”) OR nx_ship_detail (“Ship Detail Design”)
Validate¶
-
ProfileCutoutBuilder.
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.