ProfileListBuilder Class¶
-
class
NXOpen.Features.ShipDesign.
ProfileListBuilder
¶ Bases:
NXOpen.Features.FeatureBuilder
Represents a
NXOpen.Features.ShipDesign.ProfileList
builderTo create a new instance of this class, use
NXOpen.Features.ShipCollection.CreateProfileListBuilder()
New in version NX5.0.0.
Properties¶
Property | Description |
---|---|
Component | Returns the component to preview |
CuttingInterfaceConfigFile | Returns or sets the Cutting Interface configuration file |
CuttingInterfaceOutputFile | Returns or sets the Cutting Interface output XML file |
InverseBending | Returns or sets whether to include inverse bending data in the spreadsheet |
KnuckledProfile | Returns or sets whether to include knuckled profile data in the spreadsheet |
ListFile | Returns or sets the spreadsheet |
ManufacturingCollector | Returns the components of this part that contain a profile will be processed. |
OutputType | Returns or sets the output type: Spreadsheet or XML |
ParentFeatureInternal | Returns or sets whether or not the latest timestamped parent feature of this feature should be made internal |
PartSet | Returns the profile components to process |
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. |
VentilationHoles | Returns or sets whether to include ventilation hole data in the spreadsheet |
Methods¶
Method | Description |
---|---|
Commit | Commits any edits that have been applied to the builder. |
CommitFeature | Commits the feature parameters and creates the feature @return |
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. |
Enumerations¶
ProfileListBuilderOutputTypes Enumeration | Used to specify the desired output. |
Property Detail¶
Component¶
-
ProfileListBuilder.
Component
¶ Returns the component to preview
-------------------------------------
Getter Method
Signature
Component()
Returns: Return type: NXOpen.SelectDisplayableObject
New in version NX11.0.0.
License requirements: None.
CuttingInterfaceConfigFile¶
-
ProfileListBuilder.
CuttingInterfaceConfigFile
¶ Returns or sets the Cutting Interface configuration file
-------------------------------------
Getter Method
Signature
CuttingInterfaceConfigFile()
Returns: Return type: str New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CuttingInterfaceConfigFile(fileName)
Parameters: fileName (str) – New in version NX11.0.0.
License requirements: nx_ship_concept (“Ship Concept”) OR nx_ship_mfg_prep (“Ship Manufacturing”)
CuttingInterfaceOutputFile¶
-
ProfileListBuilder.
CuttingInterfaceOutputFile
¶ Returns or sets the Cutting Interface output XML file
-------------------------------------
Getter Method
Signature
CuttingInterfaceOutputFile()
Returns: Return type: str New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CuttingInterfaceOutputFile(fileName)
Parameters: fileName (str) – New in version NX11.0.0.
License requirements: nx_ship_concept (“Ship Concept”) OR nx_ship_mfg_prep (“Ship Manufacturing”)
InverseBending¶
-
ProfileListBuilder.
InverseBending
¶ Returns or sets whether to include inverse bending data in the spreadsheet
-------------------------------------
Getter Method
Signature
InverseBending()
Returns: Return type: bool New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
InverseBending(inverseBending)
Parameters: inverseBending (bool) – New in version NX5.0.0.
License requirements: nx_ship_concept (“Ship Concept”) OR nx_ship_mfg_prep (“Ship Manufacturing”)
KnuckledProfile¶
-
ProfileListBuilder.
KnuckledProfile
¶ Returns or sets whether to include knuckled profile data in the spreadsheet
-------------------------------------
Getter Method
Signature
KnuckledProfile()
Returns: Return type: bool New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
KnuckledProfile(knuckledProfile)
Parameters: knuckledProfile (bool) – New in version NX11.0.0.
License requirements: nx_ship_concept (“Ship Concept”) OR nx_ship_mfg_prep (“Ship Manufacturing”)
ListFile¶
-
ProfileListBuilder.
ListFile
¶ Returns or sets the spreadsheet
-------------------------------------
Getter Method
Signature
ListFile()
Returns: Return type: str New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ListFile(listFile)
Parameters: listFile (str) – New in version NX5.0.0.
License requirements: nx_ship_concept (“Ship Concept”) OR nx_ship_mfg_prep (“Ship Manufacturing”)
ManufacturingCollector¶
-
ProfileListBuilder.
ManufacturingCollector
¶ Returns the components of this part that contain a profile will be processed.
-------------------------------------
Getter Method
Signature
ManufacturingCollector()
Returns: Return type: NXOpen.Assemblies.SelectComponent
New in version NX11.0.0.
License requirements: None.
OutputType¶
-
ProfileListBuilder.
OutputType
¶ Returns or sets the output type: Spreadsheet or XML
-------------------------------------
Getter Method
Signature
OutputType()
Returns: Return type: NXOpen.Features.ShipDesign.ProfileListBuilderOutputTypes
New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
OutputType(outputType)
Parameters: outputType ( NXOpen.Features.ShipDesign.ProfileListBuilderOutputTypes
) –New in version NX11.0.0.
License requirements: nx_ship_detail (“Ship Detail Design”)
PartSet¶
-
ProfileListBuilder.
PartSet
¶ Returns the profile components to process
-------------------------------------
Getter Method
Signature
PartSet()
Returns: Return type: NXOpen.Assemblies.SelectComponentList
New in version NX11.0.0.
License requirements: nx_ship_concept (“Ship Concept”) OR nx_ship_mfg_prep (“Ship Manufacturing”)
VentilationHoles¶
-
ProfileListBuilder.
VentilationHoles
¶ Returns or sets whether to include ventilation hole data in the spreadsheet
-------------------------------------
Getter Method
Signature
VentilationHoles()
Returns: Return type: bool New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
VentilationHoles(ventilationHoles)
Parameters: ventilationHoles (bool) – New in version NX5.0.0.
License requirements: nx_ship_concept (“Ship Concept”) OR nx_ship_mfg_prep (“Ship Manufacturing”)
Method Detail¶
Validate¶
-
ProfileListBuilder.
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.