SteelDistributionBuilder Class¶
-
class
NXOpen.Features.ShipDesign.
SteelDistributionBuilder
¶ Bases:
NXOpen.Features.FeatureBuilder
Represents a
NXOpen.Features.ShipDesign.SteelDistribution
builderTo create a new instance of this class, use
NXOpen.Features.ShipCollection.CreateSteelDistributionBuilder()
New in version NX5.0.0.
Properties¶
Property | Description |
---|---|
AssemblyPart | Returns or sets the assembly part |
Description | Returns or sets the description |
FeatureName | Returns or sets the description |
Form | Returns or sets the form |
ItemType | Returns or sets the Item Type. |
Material | Returns or sets the material |
Name | Returns or sets the name |
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 |
SaProject | Returns or sets the sa project |
SectionNumber | Returns or sets the section number |
Size | Returns or sets the size |
SteelBodies | Returns the steel bodies |
SubComponent | Returns or sets the get subcomponent |
SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename |
Tag | Returns the Tag for this object. |
TemplateCategoryName | Returns or sets the Template Category Name. |
TemplateName | Returns or sets the Template Name. |
Type | Returns or sets the type |
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¶
Property Detail¶
AssemblyPart¶
-
SteelDistributionBuilder.
AssemblyPart
¶ Returns or sets the assembly part
-------------------------------------
Getter Method
Signature
AssemblyPart()
Returns: Return type: str New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
AssemblyPart(assemblyPart)
Parameters: assemblyPart (str) – New in version NX5.0.0.
License requirements: nx_ship_concept (“Ship Concept”)
Description¶
-
SteelDistributionBuilder.
Description
¶ Returns or sets the description
-------------------------------------
Getter Method
Signature
Description()
Returns: Return type: str New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Description(description)
Parameters: description (str) – New in version NX5.0.0.
License requirements: nx_ship_concept (“Ship Concept”)
FeatureName¶
-
SteelDistributionBuilder.
FeatureName
¶ Returns or sets the description
-------------------------------------
Getter Method
Signature
FeatureName()
Returns: Return type: str New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
FeatureName(featureName)
Parameters: featureName (str) – New in version NX5.0.0.
License requirements: nx_ship_concept (“Ship Concept”)
Form¶
-
SteelDistributionBuilder.
Form
¶ Returns or sets the form
-------------------------------------
Getter Method
Signature
Form()
Returns: Return type: NXOpen.Features.ShipDesign.SteelDistributionBuilderSaForm
New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Form(form)
Parameters: form ( NXOpen.Features.ShipDesign.SteelDistributionBuilderSaForm
) –New in version NX5.0.0.
License requirements: nx_ship_concept (“Ship Concept”)
ItemType¶
-
SteelDistributionBuilder.
ItemType
¶ Returns or sets the Item Type.
Only used in managed mode, ignored in native mode.
-------------------------------------
Getter Method
Signature
ItemType()
Returns: Return type: str New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ItemType(itemType)
Parameters: itemType (str) – New in version NX8.0.0.
License requirements: nx_ship_concept (“Ship Concept”)
Material¶
-
SteelDistributionBuilder.
Material
¶ Returns or sets the material
-------------------------------------
Getter Method
Signature
Material()
Returns: Return type: NXOpen.Features.ShipDesign.SteelDistributionBuilderSaMaterial
New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Material(material)
Parameters: material ( NXOpen.Features.ShipDesign.SteelDistributionBuilderSaMaterial
) –New in version NX5.0.0.
License requirements: nx_ship_concept (“Ship Concept”)
Name¶
-
SteelDistributionBuilder.
Name
¶ Returns or sets the name
-------------------------------------
Getter Method
Signature
Name()
Returns: Return type: NXOpen.Features.ShipDesign.SteelDistributionBuilderSaName
New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Name(name)
Parameters: name ( NXOpen.Features.ShipDesign.SteelDistributionBuilderSaName
) –New in version NX5.0.0.
License requirements: nx_ship_concept (“Ship Concept”)
SaProject¶
-
SteelDistributionBuilder.
SaProject
¶ Returns or sets the sa project
-------------------------------------
Getter Method
Signature
SaProject()
Returns: Return type: str New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SaProject(saProject)
Parameters: saProject (str) – New in version NX5.0.0.
License requirements: nx_ship_concept (“Ship Concept”)
SectionNumber¶
-
SteelDistributionBuilder.
SectionNumber
¶ Returns or sets the section number
-------------------------------------
Getter Method
Signature
SectionNumber()
Returns: Return type: str New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SectionNumber(sectionNumber)
Parameters: sectionNumber (str) – New in version NX5.0.0.
License requirements: nx_ship_concept (“Ship Concept”)
Size¶
-
SteelDistributionBuilder.
Size
¶ Returns or sets the size
-------------------------------------
Getter Method
Signature
Size()
Returns: Return type: NXOpen.Features.ShipDesign.SteelDistributionBuilderSaSize
New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Size(size)
Parameters: size ( NXOpen.Features.ShipDesign.SteelDistributionBuilderSaSize
) –New in version NX5.0.0.
License requirements: nx_ship_concept (“Ship Concept”)
SteelBodies¶
-
SteelDistributionBuilder.
SteelBodies
¶ Returns the steel bodies
-------------------------------------
Getter Method
Signature
SteelBodies()
Returns: Return type: NXOpen.SelectBodyList
New in version NX5.0.0.
License requirements: None.
SubComponent¶
-
SteelDistributionBuilder.
SubComponent
¶ Returns or sets the get subcomponent
-------------------------------------
Getter Method
Signature
SubComponent()
Returns: Return type: bool New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SubComponent(subComponent)
Parameters: subComponent (bool) – New in version NX5.0.0.
License requirements: nx_ship_concept (“Ship Concept”)
TemplateCategoryName¶
-
SteelDistributionBuilder.
TemplateCategoryName
¶ Returns or sets the Template Category Name.
Only used in managed mode, ignored in native mode.
-------------------------------------
Getter Method
Signature
TemplateCategoryName()
Returns: Return type: str New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
TemplateCategoryName(templateCategoryName)
Parameters: templateCategoryName (str) – New in version NX8.0.0.
License requirements: nx_ship_concept (“Ship Concept”)
TemplateName¶
-
SteelDistributionBuilder.
TemplateName
¶ Returns or sets the Template Name.
Only used in managed mode, ignored in native mode.
-------------------------------------
Getter Method
Signature
TemplateName()
Returns: Return type: str New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
TemplateName(templateName)
Parameters: templateName (str) – New in version NX8.0.0.
License requirements: nx_ship_concept (“Ship Concept”)
Type¶
-
SteelDistributionBuilder.
Type
¶ Returns or sets the type
-------------------------------------
Getter Method
Signature
Type()
Returns: Return type: NXOpen.Features.ShipDesign.SteelDistributionBuilderSaType
New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Type(type)
Parameters: type ( NXOpen.Features.ShipDesign.SteelDistributionBuilderSaType
) –New in version NX5.0.0.
License requirements: nx_ship_concept (“Ship Concept”)
Method Detail¶
Validate¶
-
SteelDistributionBuilder.
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.