ReferenceLineBuilder Class¶
-
class
NXOpen.Features.ShipDesign.
ReferenceLineBuilder
¶ Bases:
NXOpen.Features.FeatureBuilder
Represents a
NXOpen.Features.ShipDesign.ReferenceLine
builder.To create a new instance of this class, use
NXOpen.Features.ShipCollection.CreateReferenceLineBuilder()
New in version NX5.0.0.
Properties¶
Property | Description |
---|---|
FramePlane | Returns the grid fame plane to intersect with the face to produce the reference line. |
Offset | Returns the expression defining the offset to be applied to each grid plane before intersection. |
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 |
ReferenceFace | Returns the face to intersect with, defining the reference line. |
SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename |
Tag | Returns the Tag for this object. |
Methods¶
Method | Description |
---|---|
Commit | Commits any edits that have been applied to the builder. |
CommitFeature | Commits the feature parameters and creates the feature |
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. |
Property Detail¶
FramePlane¶
-
ReferenceLineBuilder.
FramePlane
¶ Returns the grid fame plane to intersect with the face to produce the reference line.
-------------------------------------
Getter Method
Signature
FramePlane
Returns: Return type: NXOpen.SelectDatumPlaneList
New in version NX5.0.0.
License requirements: None.
Offset¶
-
ReferenceLineBuilder.
Offset
¶ Returns the expression defining the offset to be applied to each grid plane before intersection.
-------------------------------------
Getter Method
Signature
Offset
Returns: Return type: NXOpen.Expression
New in version NX5.0.0.
License requirements: None.
ReferenceFace¶
-
ReferenceLineBuilder.
ReferenceFace
¶ Returns the face to intersect with, defining the reference line.
-------------------------------------
Getter Method
Signature
ReferenceFace
Returns: Return type: NXOpen.ScCollector
New in version NX8.0.0.
License requirements: None.
Method Detail¶
Validate¶
-
ReferenceLineBuilder.
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.