SteelVentHolesBuilder Class¶
-
class
NXOpen.Features.ShipDesign.
SteelVentHolesBuilder
¶ Bases:
NXOpen.Features.FeatureBuilder
Represents a
NXOpen.Features.ShipDesign.SteelVentHoles
builderTo create a new instance of this class, use
NXOpen.Features.ShipCollection.CreateSteelVentHolesBuilder()
Default values.
Property Value AngularDim.Value 0 GuideOffset.Value 0 (millimeters part), 0 (inches part) NumVents 2 SketchBlock.Exp1.Value 0 SketchBlock.Exp10.Value 0 SketchBlock.Exp11.Value 0 SketchBlock.Exp12.Value 0 SketchBlock.Exp2.Value 0 SketchBlock.Exp3.Value 0 SketchBlock.Exp4.Value 0 SketchBlock.Exp5.Value 0 SketchBlock.Exp6.Value 0 SketchBlock.Exp7.Value 0 SketchBlock.Exp8.Value 0 SketchBlock.Exp9.Value 0 SketchBlock.Sketches EndCut1 ToggleEqualSpacing 1 ToggleSymmetricOffset 1 VentSpacing.Value 0 (millimeters part), 0 (inches part) New in version NX7.5.0.
Properties¶
Property | Description |
---|---|
AngularDim | Returns the angular dimension used to rotate the profile of the vent holes |
GuideOffset | Returns the guide offset - the dimension used to offset the array of holes from the section guide. |
KeepReverseGuideOffset | Returns or sets the keep reverse guide offset A toggle used to remember the reverse guide value on apply. |
KeepSectionGuide | Returns or sets the keep section guide A toggle used to remember the selected object(s) on apply. |
KeepSelectEndTrim | Returns or sets the keep select end trim A toggle used to remember the selected object on apply. |
KeepSelectStartTrim | Returns or sets the keep select start trim A toggle used to remember the selected object on apply. |
KeepSelectTargetFace | Returns or sets the keep select target face A toggle used to remember the selected object(s) on apply. |
NumVents | Returns or sets the number of vent holes. |
OnPathEndOffset | Returns the offset from the start of the section to begin placing the holes. |
OnPathStartOffset | Returns the offset from the start of the section to begin placing the holes. |
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 |
ReverseGuideOffset | Returns or sets the reverse direction of the guide offset. |
SectionGuide | Returns the section guide - vent holes are placed along this guide |
SelectEndTrim | Returns the select end trim - used to trim the end of the section guide. |
SelectStartTrim | Returns the select start trim - used to trim the start of the section guide. |
SelectTargetFace | Returns the select target face. |
SketchBlock | Returns the library sketch block that defines the cut outline |
SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename |
Tag | Returns the Tag for this object. |
ToggleEqualSpacing | Returns or sets the toggle equal spacing. |
ToggleSymmetricOffset | Returns or sets the toggle for calculating automatic symmetric offsets. |
VentSpacing | Returns the spacing applied between each vent hole. |
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. |
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. |
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. |
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. |
Property Detail¶
AngularDim¶
-
SteelVentHolesBuilder.
AngularDim
¶ Returns the angular dimension used to rotate the profile of the vent holes
-------------------------------------
Getter Method
Signature
AngularDim
Returns: Return type: NXOpen.Expression
New in version NX7.5.0.
License requirements: None.
GuideOffset¶
-
SteelVentHolesBuilder.
GuideOffset
¶ Returns the guide offset - the dimension used to offset the array of holes from the section guide.
-------------------------------------
Getter Method
Signature
GuideOffset
Returns: Return type: NXOpen.Expression
New in version NX7.5.0.
License requirements: None.
KeepReverseGuideOffset¶
-
SteelVentHolesBuilder.
KeepReverseGuideOffset
¶ Returns or sets the keep reverse guide offset A toggle used to remember the reverse guide value on apply.
-------------------------------------
Getter Method
Signature
KeepReverseGuideOffset
Returns: Return type: bool New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
KeepReverseGuideOffset
Parameters: keepReverseGuideOffset (bool) – New in version NX7.5.0.
License requirements: nx_ship_concept (“Ship Concept”)
KeepSectionGuide¶
-
SteelVentHolesBuilder.
KeepSectionGuide
¶ Returns or sets the keep section guide A toggle used to remember the selected object(s) on apply.
-------------------------------------
Getter Method
Signature
KeepSectionGuide
Returns: Return type: bool New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
KeepSectionGuide
Parameters: keepSectionGuide (bool) – New in version NX7.5.0.
License requirements: nx_ship_concept (“Ship Concept”)
KeepSelectEndTrim¶
-
SteelVentHolesBuilder.
KeepSelectEndTrim
¶ Returns or sets the keep select end trim A toggle used to remember the selected object on apply.
-------------------------------------
Getter Method
Signature
KeepSelectEndTrim
Returns: Return type: bool New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
KeepSelectEndTrim
Parameters: keepSelectEndTrim (bool) – New in version NX7.5.0.
License requirements: nx_ship_concept (“Ship Concept”)
KeepSelectStartTrim¶
-
SteelVentHolesBuilder.
KeepSelectStartTrim
¶ Returns or sets the keep select start trim A toggle used to remember the selected object on apply.
-------------------------------------
Getter Method
Signature
KeepSelectStartTrim
Returns: Return type: bool New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
KeepSelectStartTrim
Parameters: keepSelectStartTrim (bool) – New in version NX7.5.0.
License requirements: nx_ship_concept (“Ship Concept”)
KeepSelectTargetFace¶
-
SteelVentHolesBuilder.
KeepSelectTargetFace
¶ Returns or sets the keep select target face A toggle used to remember the selected object(s) on apply.
-------------------------------------
Getter Method
Signature
KeepSelectTargetFace
Returns: Return type: bool New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
KeepSelectTargetFace
Parameters: keepSelectTargetFace (bool) – New in version NX7.5.0.
License requirements: nx_ship_concept (“Ship Concept”)
NumVents¶
-
SteelVentHolesBuilder.
NumVents
¶ Returns or sets the number of vent holes.
-------------------------------------
Getter Method
Signature
NumVents
Returns: Return type: int New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
NumVents
Parameters: numVents (int) – New in version NX7.5.0.
License requirements: nx_ship_concept (“Ship Concept”)
OnPathEndOffset¶
-
SteelVentHolesBuilder.
OnPathEndOffset
¶ Returns the offset from the start of the section to begin placing the holes.
(used with the equal spacing option)
-------------------------------------
Getter Method
Signature
OnPathEndOffset
Returns: Return type: NXOpen.GeometricUtilities.OnPathDimensionBuilder
New in version NX7.5.0.
License requirements: None.
OnPathStartOffset¶
-
SteelVentHolesBuilder.
OnPathStartOffset
¶ Returns the offset from the start of the section to begin placing the holes.
-------------------------------------
Getter Method
Signature
OnPathStartOffset
Returns: Return type: NXOpen.GeometricUtilities.OnPathDimensionBuilder
New in version NX7.5.0.
License requirements: None.
ReverseGuideOffset¶
-
SteelVentHolesBuilder.
ReverseGuideOffset
¶ Returns or sets the reverse direction of the guide offset.
Allows you to reverse the direction used in the guide offset.
-------------------------------------
Getter Method
Signature
ReverseGuideOffset
Returns: Return type: bool New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ReverseGuideOffset
Parameters: reverseGuideOffset (bool) – New in version NX7.5.0.
License requirements: nx_ship_concept (“Ship Concept”)
SectionGuide¶
-
SteelVentHolesBuilder.
SectionGuide
¶ Returns the section guide - vent holes are placed along this guide
-------------------------------------
Getter Method
Signature
SectionGuide
Returns: Return type: NXOpen.Section
New in version NX7.5.0.
License requirements: None.
SelectEndTrim¶
-
SteelVentHolesBuilder.
SelectEndTrim
¶ Returns the select end trim - used to trim the end of the section guide.
-------------------------------------
Getter Method
Signature
SelectEndTrim
Returns: Return type: NXOpen.SelectTaggedObject
New in version NX7.5.0.
License requirements: None.
SelectStartTrim¶
-
SteelVentHolesBuilder.
SelectStartTrim
¶ Returns the select start trim - used to trim the start of the section guide.
-------------------------------------
Getter Method
Signature
SelectStartTrim
Returns: Return type: NXOpen.SelectTaggedObject
New in version NX7.5.0.
License requirements: None.
SelectTargetFace¶
-
SteelVentHolesBuilder.
SelectTargetFace
¶ Returns the select target face.
Specifies the face(s) to cut holes in.
-------------------------------------
Getter Method
Signature
SelectTargetFace
Returns: Return type: NXOpen.SelectTaggedObjectList
New in version NX7.5.0.
License requirements: None.
SketchBlock¶
-
SteelVentHolesBuilder.
SketchBlock
¶ Returns the library sketch block that defines the cut outline
-------------------------------------
Getter Method
Signature
SketchBlock
Returns: Return type: NXOpen.SketchExpressionModifierBuilder
New in version NX7.5.0.
License requirements: None.
ToggleEqualSpacing¶
-
SteelVentHolesBuilder.
ToggleEqualSpacing
¶ Returns or sets the toggle equal spacing.
Indicates that an equal amount of space is placed between each hole along the guide.
-------------------------------------
Getter Method
Signature
ToggleEqualSpacing
Returns: Return type: bool New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ToggleEqualSpacing
Parameters: toggleEqualSpacing (bool) – New in version NX7.5.0.
License requirements: nx_ship_concept (“Ship Concept”)
ToggleSymmetricOffset¶
-
SteelVentHolesBuilder.
ToggleSymmetricOffset
¶ Returns or sets the toggle for calculating automatic symmetric offsets.
(only used with the equal spacing option) If you toggle on both equal spacing and symmetric offsets, and the length of the secion is L, the distance between each hole is L/n, and both of the offsets equal L/(2n)
-------------------------------------
Getter Method
Signature
ToggleSymmetricOffset
Returns: Return type: bool New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ToggleSymmetricOffset
Parameters: toggleSymmetricOffset (bool) – New in version NX7.5.0.
License requirements: nx_ship_concept (“Ship Concept”)
VentSpacing¶
-
SteelVentHolesBuilder.
VentSpacing
¶ Returns the spacing applied between each vent hole.
(not used with the equal spacing option)
-------------------------------------
Getter Method
Signature
VentSpacing
Returns: Return type: NXOpen.Expression
New in version NX7.5.0.
License requirements: None.
Method Detail¶
Validate¶
-
SteelVentHolesBuilder.
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.