TransFrameBuilder Class¶
-
class
NXOpen.Features.ShipDesign.TransFrameBuilder¶ Bases:
NXOpen.Features.FeatureBuilderRepresents a
NXOpen.Features.ShipDesign.TransFramebuilderTo create a new instance of this class, use
NXOpen.Features.ShipCollection.CreateTransFrameBuilder()New in version NX5.0.0.
Properties¶
| Property | Description |
|---|---|
| AttribName | Returns or sets the attribute for name type. |
| AttribRef | Returns or sets the attribute for reference type. |
| FeatureNameSuffix | Returns or sets the suffix name. |
| NegateFrame | Returns or sets the reverse index since where frames turn to opposite. |
| 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 |
| SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename |
| Tag | Returns the Tag for this object. |
| TransFrameNegList | Returns the negative list. |
| TransFramePosList | Returns the positive list. |
Methods¶
| Method | Description |
|---|---|
| Commit | Commits any edits that have been applied to the builder. |
| CommitFeature | Commits the feature parameters and creates the feature |
| CreateTransFrameListItem | Create a list containing all required info to generate transverse frame. |
| 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¶
AttribName¶
-
TransFrameBuilder.AttribName¶ Returns or sets the attribute for name type.
-------------------------------------Getter Method
Signature
AttribNameReturns: Return type: str New in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
AttribNameParameters: attribName (str) – New in version NX5.0.0.
License requirements: nx_ship_concept (“Ship Concept”) OR nx_ship_basic (“Ship Basic Design”) OR nx_ship_detail (“Ship Detail Design”)
AttribRef¶
-
TransFrameBuilder.AttribRef¶ Returns or sets the attribute for reference type.
-------------------------------------Getter Method
Signature
AttribRefReturns: Return type: str New in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
AttribRefParameters: attribRef (str) – New in version NX5.0.0.
License requirements: nx_ship_concept (“Ship Concept”) OR nx_ship_basic (“Ship Basic Design”) OR nx_ship_detail (“Ship Detail Design”)
FeatureNameSuffix¶
-
TransFrameBuilder.FeatureNameSuffix¶ Returns or sets the suffix name.
-------------------------------------Getter Method
Signature
FeatureNameSuffixReturns: Return type: str New in version NX5.3.0.
License requirements: None.
-------------------------------------Setter Method
Signature
FeatureNameSuffixParameters: featureNameSuffix (str) – New in version NX5.3.0.
License requirements: nx_ship_concept (“Ship Concept”) OR nx_ship_basic (“Ship Basic Design”) OR nx_ship_detail (“Ship Detail Design”)
NegateFrame¶
-
TransFrameBuilder.NegateFrame¶ Returns or sets the reverse index since where frames turn to opposite.
-------------------------------------Getter Method
Signature
NegateFrameReturns: Return type: int New in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
NegateFrameParameters: negateFrame (int) – New in version NX5.0.0.
License requirements: nx_ship_concept (“Ship Concept”) OR nx_ship_basic (“Ship Basic Design”) OR nx_ship_detail (“Ship Detail Design”)
TransFrameNegList¶
-
TransFrameBuilder.TransFrameNegList¶ Returns the negative list.
-------------------------------------Getter Method
Signature
TransFrameNegListReturns: Return type: NXOpen.Features.ShipDesign.TransFrameListItemBuilderListNew in version NX5.0.0.
License requirements: None.
TransFramePosList¶
-
TransFrameBuilder.TransFramePosList¶ Returns the positive list.
-------------------------------------Getter Method
Signature
TransFramePosListReturns: Return type: NXOpen.Features.ShipDesign.TransFrameListItemBuilderListNew in version NX5.0.0.
License requirements: None.
Method Detail¶
CreateTransFrameListItem¶
-
TransFrameBuilder.CreateTransFrameListItem¶ Create a list containing all required info to generate transverse frame.
Signature
CreateTransFrameListItem()Returns: Return type: NXOpen.Features.ShipDesign.TransFrameListItemBuilderNew in version NX8.0.0.
License requirements: nx_ship_concept (“Ship Concept”) OR nx_ship_basic (“Ship Basic Design”) OR nx_ship_detail (“Ship Detail Design”)
Validate¶
-
TransFrameBuilder.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.