ShellTemplateBuilder Class¶
-
class
NXOpen.Features.ShipDesign.ShellTemplateBuilder¶ Bases:
NXOpen.Features.FeatureBuilderUsed to edit or create a
NXOpen.Features.ShipDesign.ShellTemplatefeature.The shell templates are defined on a surface by specifying a primary orientation coordinate system. The orientation coordinate system is then used to build, or filter, planes used to locate each individual template. There are 2 primary methods for defining the input. Manual allows for specific, selected, data to limit various aspects of the build (for example, build with only 1 plane). Inferred allows for the tools to generate data, thus building with a minimal of predefined input data.
To create a new instance of this class, use
NXOpen.Features.ShipCollection.CreateShellTemplateBuilder()Default values.
Property Value CreateSeparateParts 0 EndXTemplateOffset.Value 0 (millimeters part), 0 (inches part) EndYTemplateOffset.Value 0 (millimeters part), 0 (inches part) MarkingLinesDirectionType XandYDirections PlaneMethod Existing StartXTemplateOffset.Value 0 (millimeters part), 0 (inches part) StartYTemplateOffset.Value 0 (millimeters part), 0 (inches part) Thickness.Value 0 (millimeters part), 0 (inches part) XOffset.Value 300.0 (millimeters part), 12.0 (inches part) YOffset.Value 300.0 (millimeters part), 12.0 (inches part) New in version NX8.0.0.
Properties¶
| Property | Description |
|---|---|
| AngleTolerance | Returns or sets the modeling angle tolerance. |
| CoordinateSystem | Returns or sets the coordinate system defining the origin as well as the X and Y axis for the templates. |
| CreateSeparateParts | Returns or sets the value that determines if separate pars are created |
| DistanceTolerance | Returns or sets the modeling distance tolerance. |
| EndXTemplateOffset | Returns the expression defining the value of the end offset of the template for set 1 (X). |
| EndYTemplateOffset | Returns the expression defining the value of the end offset of the template for set 2 (Y). |
| MarkingLinesDirectionType | Returns or sets the value that specifies which marking lines are drawn on the plate |
| 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 |
| PlaneAutomatic | Returns the planes specifying both the X and Y orientations of the templates. |
| PlaneMethod | Returns or sets the value identifying how the planes (used for sections) will be specified (See NXOpen.Features.ShipDesign.ShellTemplateBuilderPlaneLocationTypes for the plane methods). |
| SpecifyXPlane | Returns or sets the plane specifying the X direction for the coordinate system. |
| SpecifyYPlane | Returns or sets the plane specifying the Y direction for the coordinate system. |
| StartXTemplateOffset | Returns the expression defining the value of the start offset of the template for set 1 (X). |
| StartYTemplateOffset | Returns the expression defining the value of the start offset of the template for set 2 (Y). |
| Surface | Returns the surface that the templates will be built to. |
| SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename |
| Tag | Returns the Tag for this object. |
| TemplateSetName | Returns or sets the template set name assigned to the part attribute |
| Thickness | Returns the expression defining the value of the thickness of the template. |
| Type | Returns or sets the value defining how the coordinate system will be defined. |
| XOffset | Returns the expression defining the value of the offset to apply in the X direction. |
| XPlaneUserDefined | Returns or sets the value specifying that the plane for the X direction was user defined. |
| YOffset | Returns the expression defining the value of the offset to apply in the Y direction. |
| YPlaneUserDefined | Returns or sets the value specifying that the plane for the Y direction was user defined. |
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¶
| ShellTemplateBuilderMarkingTypes Enumeration | The option for controlling which marking lines are drawn on the plate |
| ShellTemplateBuilderPlaneLocationTypes Enumeration | The option for how the plane locations will be specified as input. |
| ShellTemplateBuilderTypes Enumeration | The option for controlling how the coordinate system for template creation is specified. |
Property Detail¶
AngleTolerance¶
-
ShellTemplateBuilder.AngleTolerance¶ Returns or sets the modeling angle tolerance.
-------------------------------------Getter Method
Signature
AngleTolerance()Returns: Return type: float New in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
AngleTolerance(angleTolerance)Parameters: angleTolerance (float) – New in version NX8.0.0.
License requirements: nx_ship_concept (“Ship Concept”) OR nx_ship_mfg_prep (“Ship Manufacturing”)
CoordinateSystem¶
-
ShellTemplateBuilder.CoordinateSystem¶ Returns or sets the coordinate system defining the origin as well as the X and Y axis for the templates.
-------------------------------------Getter Method
Signature
CoordinateSystem()Returns: Return type: NXOpen.CoordinateSystemNew in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
CoordinateSystem(coordinateSystem)Parameters: coordinateSystem ( NXOpen.CoordinateSystem) –New in version NX8.0.0.
License requirements: nx_ship_concept (“Ship Concept”) OR nx_ship_mfg_prep (“Ship Manufacturing”)
CreateSeparateParts¶
-
ShellTemplateBuilder.CreateSeparateParts¶ Returns or sets the value that determines if separate pars are created
-------------------------------------Getter Method
Signature
CreateSeparateParts()Returns: Return type: bool New in version NX10.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
CreateSeparateParts(createSeparateParts)Parameters: createSeparateParts (bool) – New in version NX10.0.0.
License requirements: nx_ship_concept (“Ship Concept”) OR nx_ship_mfg_prep (“Ship Manufacturing”)
DistanceTolerance¶
-
ShellTemplateBuilder.DistanceTolerance¶ Returns or sets the modeling distance tolerance.
-------------------------------------Getter Method
Signature
DistanceTolerance()Returns: Return type: float New in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
DistanceTolerance(distanceTolerance)Parameters: distanceTolerance (float) – New in version NX8.0.0.
License requirements: nx_ship_concept (“Ship Concept”) OR nx_ship_mfg_prep (“Ship Manufacturing”)
EndXTemplateOffset¶
-
ShellTemplateBuilder.EndXTemplateOffset¶ Returns the expression defining the value of the end offset of the template for set 1 (X).
-------------------------------------Getter Method
Signature
EndXTemplateOffset()Returns: Return type: NXOpen.ExpressionNew in version NX8.0.0.
License requirements: None.
EndYTemplateOffset¶
-
ShellTemplateBuilder.EndYTemplateOffset¶ Returns the expression defining the value of the end offset of the template for set 2 (Y).
-------------------------------------Getter Method
Signature
EndYTemplateOffset()Returns: Return type: NXOpen.ExpressionNew in version NX8.0.0.
License requirements: None.
MarkingLinesDirectionType¶
-
ShellTemplateBuilder.MarkingLinesDirectionType¶ Returns or sets the value that specifies which marking lines are drawn on the plate
-------------------------------------Getter Method
Signature
MarkingLinesDirectionType()Returns: Return type: NXOpen.Features.ShipDesign.ShellTemplateBuilderMarkingTypesNew in version NX10.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
MarkingLinesDirectionType(markingLinesDirectionType)Parameters: markingLinesDirectionType ( NXOpen.Features.ShipDesign.ShellTemplateBuilderMarkingTypes) –New in version NX10.0.0.
License requirements: nx_ship_concept (“Ship Concept”) OR nx_ship_mfg_prep (“Ship Manufacturing”)
PlaneAutomatic¶
-
ShellTemplateBuilder.PlaneAutomatic¶ Returns the planes specifying both the X and Y orientations of the templates.
They will automatically be separated, or grouped, for X and Y as needed. This is only valid when
NXOpen.Features.ShipDesign.ShellTemplateBuilderPlaneLocationTypesisNXOpen.Features.ShipDesign.ShellTemplateBuilderPlaneLocationTypes.Existing.-------------------------------------Getter Method
Signature
PlaneAutomatic()Returns: Return type: NXOpen.SelectIBasePlaneListNew in version NX8.0.0.
License requirements: None.
PlaneMethod¶
-
ShellTemplateBuilder.PlaneMethod¶ Returns or sets the value identifying how the planes (used for sections) will be specified (See
NXOpen.Features.ShipDesign.ShellTemplateBuilderPlaneLocationTypesfor the plane methods).-------------------------------------Getter Method
Signature
PlaneMethod()Returns: Return type: NXOpen.Features.ShipDesign.ShellTemplateBuilderPlaneLocationTypesNew in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
PlaneMethod(planeMethod)Parameters: planeMethod ( NXOpen.Features.ShipDesign.ShellTemplateBuilderPlaneLocationTypes) –New in version NX8.0.0.
License requirements: nx_ship_concept (“Ship Concept”) OR nx_ship_mfg_prep (“Ship Manufacturing”)
SpecifyXPlane¶
-
ShellTemplateBuilder.SpecifyXPlane¶ Returns or sets the plane specifying the X direction for the coordinate system.
-------------------------------------Getter Method
Signature
SpecifyXPlane()Returns: Return type: NXOpen.PlaneNew in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
SpecifyXPlane(specifyXPlane)Parameters: specifyXPlane ( NXOpen.Plane) –New in version NX8.0.0.
License requirements: nx_ship_concept (“Ship Concept”) OR nx_ship_mfg_prep (“Ship Manufacturing”)
SpecifyYPlane¶
-
ShellTemplateBuilder.SpecifyYPlane¶ Returns or sets the plane specifying the Y direction for the coordinate system.
-------------------------------------Getter Method
Signature
SpecifyYPlane()Returns: Return type: NXOpen.PlaneNew in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
SpecifyYPlane(specifyYPlane)Parameters: specifyYPlane ( NXOpen.Plane) –New in version NX8.0.0.
License requirements: nx_ship_concept (“Ship Concept”) OR nx_ship_mfg_prep (“Ship Manufacturing”)
StartXTemplateOffset¶
-
ShellTemplateBuilder.StartXTemplateOffset¶ Returns the expression defining the value of the start offset of the template for set 1 (X).
-------------------------------------Getter Method
Signature
StartXTemplateOffset()Returns: Return type: NXOpen.ExpressionNew in version NX8.0.0.
License requirements: None.
StartYTemplateOffset¶
-
ShellTemplateBuilder.StartYTemplateOffset¶ Returns the expression defining the value of the start offset of the template for set 2 (Y).
-------------------------------------Getter Method
Signature
StartYTemplateOffset()Returns: Return type: NXOpen.ExpressionNew in version NX8.0.0.
License requirements: None.
Surface¶
-
ShellTemplateBuilder.Surface¶ Returns the surface that the templates will be built to.
-------------------------------------Getter Method
Signature
Surface()Returns: Return type: NXOpen.ScCollectorNew in version NX8.0.0.
License requirements: None.
TemplateSetName¶
-
ShellTemplateBuilder.TemplateSetName¶ Returns or sets the template set name assigned to the part attribute
-------------------------------------Getter Method
Signature
TemplateSetName()Returns: Return type: str New in version NX10.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
TemplateSetName(templateSetName)Parameters: templateSetName (str) – New in version NX10.0.0.
License requirements: nx_ship_concept (“Ship Concept”) OR nx_ship_mfg_prep (“Ship Manufacturing”)
Thickness¶
-
ShellTemplateBuilder.Thickness¶ Returns the expression defining the value of the thickness of the template.
-------------------------------------Getter Method
Signature
Thickness()Returns: Return type: NXOpen.ExpressionNew in version NX8.0.0.
License requirements: None.
Type¶
-
ShellTemplateBuilder.Type¶ Returns or sets the value defining how the coordinate system will be defined.
See
NXOpen.Features.ShipDesign.ShellTemplateBuilderTypes.-------------------------------------Getter Method
Signature
Type()Returns: Return type: NXOpen.Features.ShipDesign.ShellTemplateBuilderTypesNew in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
Type(type)Parameters: type ( NXOpen.Features.ShipDesign.ShellTemplateBuilderTypes) –New in version NX8.0.0.
License requirements: nx_ship_concept (“Ship Concept”) OR nx_ship_mfg_prep (“Ship Manufacturing”)
XOffset¶
-
ShellTemplateBuilder.XOffset¶ Returns the expression defining the value of the offset to apply in the X direction.
-------------------------------------Getter Method
Signature
XOffset()Returns: Return type: NXOpen.ExpressionNew in version NX8.0.0.
License requirements: None.
XPlaneUserDefined¶
-
ShellTemplateBuilder.XPlaneUserDefined¶ Returns or sets the value specifying that the plane for the X direction was user defined.
-------------------------------------Getter Method
Signature
XPlaneUserDefined()Returns: Return type: bool New in version NX8.0.1.
License requirements: None.
-------------------------------------Setter Method
Signature
XPlaneUserDefined(xPlaneUserDefined)Parameters: xPlaneUserDefined (bool) – New in version NX8.0.1.
License requirements: nx_ship_concept (“Ship Concept”) OR nx_ship_mfg_prep (“Ship Manufacturing”)
YOffset¶
-
ShellTemplateBuilder.YOffset¶ Returns the expression defining the value of the offset to apply in the Y direction.
-------------------------------------Getter Method
Signature
YOffset()Returns: Return type: NXOpen.ExpressionNew in version NX8.0.0.
License requirements: None.
YPlaneUserDefined¶
-
ShellTemplateBuilder.YPlaneUserDefined¶ Returns or sets the value specifying that the plane for the Y direction was user defined.
-------------------------------------Getter Method
Signature
YPlaneUserDefined()Returns: Return type: bool New in version NX8.0.1.
License requirements: None.
-------------------------------------Setter Method
Signature
YPlaneUserDefined(yPlaneUserDefined)Parameters: yPlaneUserDefined (bool) – New in version NX8.0.1.
License requirements: nx_ship_concept (“Ship Concept”) OR nx_ship_mfg_prep (“Ship Manufacturing”)
Method Detail¶
Validate¶
-
ShellTemplateBuilder.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.