ShipFeatureConverter Class¶
-
class
NXOpen.Features.ShipDesign.ShipFeatureConverter¶ Bases:
NXOpen.BuilderThis class is used to convert/upgrade legacy Ship Design features.
It currently supports the conversion of KF Steel Features into non-KF Steel features.
To create a new instance of this class, use
NXOpen.Features.ShipCollection.CreateShipFeatureConverter()Default values.
Property Value Scope WorkPart New in version NX7.5.0.
Properties¶
| Property | Description |
|---|---|
| NumCandidateFeatures | Returns the number of candidate features. |
| NumConvertedFeatures | Returns the number of converted features. |
| Scope | Returns or sets the conversion scope |
| Tag | Returns the Tag for this object. |
Methods¶
| Method | Description |
|---|---|
| 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. |
| 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. |
Enumerations¶
| ShipFeatureConverterPartScope Enumeration | Settings for the conversion scope |
Property Detail¶
NumCandidateFeatures¶
-
ShipFeatureConverter.NumCandidateFeatures¶ Returns the number of candidate features.
This is only set after committing the converter.
-------------------------------------Getter Method
Signature
NumCandidateFeaturesReturns: Return type: int New in version NX7.5.0.
License requirements: None.
NumConvertedFeatures¶
-
ShipFeatureConverter.NumConvertedFeatures¶ Returns the number of converted features.
This is only set after committing the converter.
-------------------------------------Getter Method
Signature
NumConvertedFeaturesReturns: Return type: int New in version NX7.5.0.
License requirements: None.
Scope¶
-
ShipFeatureConverter.Scope¶ Returns or sets the conversion scope
-------------------------------------Getter Method
Signature
ScopeReturns: Return type: NXOpen.Features.ShipDesign.ShipFeatureConverterPartScopeNew in version NX7.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ScopeParameters: scope ( NXOpen.Features.ShipDesign.ShipFeatureConverterPartScope) –New in version NX7.5.0.
License requirements: nx_ship_concept (“Ship Concept”)
Method Detail¶
Validate¶
-
ShipFeatureConverter.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.