SplitProfilePlateBuilder Class¶
-
class
NXOpen.Features.ShipDesign.SplitProfilePlateBuilder¶ Bases:
NXOpen.BuilderRepresents a
NXOpen.Features.ShipDesign.SplitProfilePlateBuilder.This class is for splitting ship profile/plate solidbodies
To create a new instance of this class, use
NXOpen.Features.ShipCollection.CreateSplitProfilePlateBuilder()Default values.
Property Value BuiltUpOffset.FlangeAngle.Value 0 BuiltUpOffset.FlangeOffset.Value 0 (millimeters part), 0 (inches part) BuiltUpOffset.WebAngle.Value 0 BuiltUpOffset.WebOffset.Value 0 (millimeters part), 0 (inches part) ToolOption Plane New in version NX8.0.0.
Properties¶
| Property | Description |
|---|---|
| ApplyEndCut | Returns or sets the option to indicate whether to apply the end cut to the profiles |
| BuiltUpOffset | Returns the built-up offset data |
| DistanceTolerance | Returns or sets the distance tolerance to determine if a profile is attached to a plate |
| DoTrimWithoutCopy | Returns or sets the option to determine if target bodies will be copied. |
| ReverseDirection | Returns or sets the reverse direction option of tool datum or face for split. |
| SplitDirectionOption | Returns or sets the option to split profile/plate along tool face or perpendicular to profile/plate molding face. |
| Tag | Returns the Tag for this object. |
| TargetBuiltUps | Returns the target built-up solid bodies for split. |
| TargetProfileOrPlates | Returns the target profile or plate solid bodies for split. |
| TargetType | Returns or sets the profile type of split target. |
| ToolCurves | Returns the tool curve(s) to create extrude face for split. |
| ToolFaces | Returns the selected tool datum or face(s) for split. |
| ToolNewPlane | Returns or sets the created new tool datum for split. |
| ToolOption | Returns or sets the tool type for split. |
| ToolVector | Returns or sets the tool vector to create extrude face for split. |
| TrimDirection | Returns or sets the trim direction, which works together with Reverse Direction option, to determine which part of target body will be trimmed. |
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¶
| SplitProfilePlateBuilderProfileType Enumeration | Represents the target body type. |
| SplitProfilePlateBuilderSplitDirectionOptionType Enumeration | Represents split direction to trim profile or plate solid body . |
| SplitProfilePlateBuilderToolOptionType Enumeration | Represents trim tool type to trim profile or plate solid body. |
Property Detail¶
ApplyEndCut¶
-
SplitProfilePlateBuilder.ApplyEndCut¶ Returns or sets the option to indicate whether to apply the end cut to the profiles
-------------------------------------Getter Method
Signature
ApplyEndCut()Returns: Return type: bool New in version NX9.0.0.
License requirements: nx_ship_detail (“Ship Detail Design”)
-------------------------------------Setter Method
Signature
ApplyEndCut(applyEndCut)Parameters: applyEndCut (bool) – New in version NX9.0.0.
License requirements: nx_ship_detail (“Ship Detail Design”)
BuiltUpOffset¶
-
SplitProfilePlateBuilder.BuiltUpOffset¶ Returns the built-up offset data
-------------------------------------Getter Method
Signature
BuiltUpOffset()Returns: Return type: NXOpen.Features.ShipDesign.BuiltUpOffsetBuilderNew in version NX9.0.0.
License requirements: nx_ship_detail (“Ship Detail Design”)
DistanceTolerance¶
-
SplitProfilePlateBuilder.DistanceTolerance¶ Returns or sets the distance tolerance to determine if a profile is attached to a plate
-------------------------------------Getter Method
Signature
DistanceTolerance()Returns: Return type: float New in version NX8.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
DistanceTolerance(dDistnaceTolerance)Parameters: dDistnaceTolerance (float) – New in version NX8.5.0.
License requirements: nx_ship_detail (“Ship Detail Design”)
DoTrimWithoutCopy¶
-
SplitProfilePlateBuilder.DoTrimWithoutCopy¶ Returns or sets the option to determine if target bodies will be copied.
-------------------------------------Getter Method
Signature
DoTrimWithoutCopy()Returns: Return type: bool New in version NX9.0.0.
License requirements: nx_ship_detail (“Ship Detail Design”)
-------------------------------------Setter Method
Signature
DoTrimWithoutCopy(doTrimWithoutCopy)Parameters: doTrimWithoutCopy (bool) – New in version NX9.0.0.
License requirements: nx_ship_detail (“Ship Detail Design”)
ReverseDirection¶
-
SplitProfilePlateBuilder.ReverseDirection¶ Returns or sets the reverse direction option of tool datum or face for split.
-------------------------------------Getter Method
Signature
ReverseDirection()Returns: Return type: bool New in version NX8.0.0.
License requirements: nx_ship_detail (“Ship Detail Design”)
-------------------------------------Setter Method
Signature
ReverseDirection(reverseDirection)Parameters: reverseDirection (bool) – New in version NX8.0.0.
License requirements: nx_ship_detail (“Ship Detail Design”)
SplitDirectionOption¶
-
SplitProfilePlateBuilder.SplitDirectionOption¶ Returns or sets the option to split profile/plate along tool face or perpendicular to profile/plate molding face.
-------------------------------------Getter Method
Signature
SplitDirectionOption()Returns: Return type: NXOpen.Features.ShipDesign.SplitProfilePlateBuilderSplitDirectionOptionTypeNew in version NX8.0.0.
License requirements: nx_ship_detail (“Ship Detail Design”)
-------------------------------------Setter Method
Signature
SplitDirectionOption(splitDirectionOption)Parameters: splitDirectionOption ( NXOpen.Features.ShipDesign.SplitProfilePlateBuilderSplitDirectionOptionType) –New in version NX8.0.0.
License requirements: nx_ship_detail (“Ship Detail Design”)
TargetBuiltUps¶
-
SplitProfilePlateBuilder.TargetBuiltUps¶ Returns the target built-up solid bodies for split.
-------------------------------------Getter Method
Signature
TargetBuiltUps()Returns: Return type: NXOpen.SelectNXObjectListNew in version NX9.0.0.
License requirements: nx_ship_detail (“Ship Detail Design”)
TargetProfileOrPlates¶
-
SplitProfilePlateBuilder.TargetProfileOrPlates¶ Returns the target profile or plate solid bodies for split.
-------------------------------------Getter Method
Signature
TargetProfileOrPlates()Returns: Return type: NXOpen.SelectNXObjectListNew in version NX8.0.0.
License requirements: nx_ship_detail (“Ship Detail Design”)
TargetType¶
-
SplitProfilePlateBuilder.TargetType¶ Returns or sets the profile type of split target.
-------------------------------------Getter Method
Signature
TargetType()Returns: Return type: NXOpen.Features.ShipDesign.SplitProfilePlateBuilderProfileTypeNew in version NX9.0.0.
License requirements: nx_ship_detail (“Ship Detail Design”)
-------------------------------------Setter Method
Signature
TargetType(profileType)Parameters: profileType ( NXOpen.Features.ShipDesign.SplitProfilePlateBuilderProfileType) –New in version NX9.0.0.
License requirements: nx_ship_detail (“Ship Detail Design”)
ToolCurves¶
-
SplitProfilePlateBuilder.ToolCurves¶ Returns the tool curve(s) to create extrude face for split.
-------------------------------------Getter Method
Signature
ToolCurves()Returns: Return type: NXOpen.SelectNXObjectListNew in version NX8.0.0.
License requirements: nx_ship_detail (“Ship Detail Design”)
ToolFaces¶
-
SplitProfilePlateBuilder.ToolFaces¶ Returns the selected tool datum or face(s) for split.
-------------------------------------Getter Method
Signature
ToolFaces()Returns: Return type: NXOpen.SelectNXObjectListNew in version NX8.0.0.
License requirements: nx_ship_detail (“Ship Detail Design”)
ToolNewPlane¶
-
SplitProfilePlateBuilder.ToolNewPlane¶ Returns or sets the created new tool datum for split.
-------------------------------------Getter Method
Signature
ToolNewPlane()Returns: Return type: NXOpen.PlaneNew in version NX8.0.0.
License requirements: nx_ship_detail (“Ship Detail Design”)
-------------------------------------Setter Method
Signature
ToolNewPlane(toolNewPlane)Parameters: toolNewPlane ( NXOpen.Plane) –New in version NX8.0.0.
License requirements: nx_ship_detail (“Ship Detail Design”)
ToolOption¶
-
SplitProfilePlateBuilder.ToolOption¶ Returns or sets the tool type for split.
-------------------------------------Getter Method
Signature
ToolOption()Returns: Return type: NXOpen.Features.ShipDesign.SplitProfilePlateBuilderToolOptionTypeNew in version NX8.0.0.
License requirements: nx_ship_detail (“Ship Detail Design”)
-------------------------------------Setter Method
Signature
ToolOption(toolOption)Parameters: toolOption ( NXOpen.Features.ShipDesign.SplitProfilePlateBuilderToolOptionType) –New in version NX8.0.0.
License requirements: nx_ship_detail (“Ship Detail Design”)
ToolVector¶
-
SplitProfilePlateBuilder.ToolVector¶ Returns or sets the tool vector to create extrude face for split.
-------------------------------------Getter Method
Signature
ToolVector()Returns: Return type: NXOpen.DirectionNew in version NX8.0.0.
License requirements: nx_ship_detail (“Ship Detail Design”)
-------------------------------------Setter Method
Signature
ToolVector(toolVector)Parameters: toolVector ( NXOpen.Direction) –New in version NX8.0.0.
License requirements: nx_ship_detail (“Ship Detail Design”)
TrimDirection¶
-
SplitProfilePlateBuilder.TrimDirection¶ Returns or sets the trim direction, which works together with Reverse Direction option, to determine which part of target body will be trimmed.
-------------------------------------Getter Method
Signature
TrimDirection()Returns: Return type: NXOpen.Vector3dNew in version NX9.0.0.
License requirements: nx_ship_detail (“Ship Detail Design”)
-------------------------------------Setter Method
Signature
TrimDirection(trimDirection)Parameters: trimDirection ( NXOpen.Vector3d) –New in version NX9.0.0.
License requirements: nx_ship_detail (“Ship Detail Design”)
Method Detail¶
Validate¶
-
SplitProfilePlateBuilder.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.