WaveDatumBuilder Class

class NXOpen.Features.WaveDatumBuilder

Bases: NXOpen.Features.FeatureBuilder

Represents a Wave Datum builder.

To create a new instance of this class, use NXOpen.Features.FeatureCollection.CreateWaveDatumBuilder()

Default values.

Property Value
Associative True
DisplayScale 2.0
InheritDisplayProperties False
ParentPart OtherPart

New in version NX5.0.0.

Properties

Property Description
Associative Returns or sets the associative
Datums Returns the datum to link
DisplayScale Returns or sets the display scale
HideOriginal Returns or sets the hideoriginal
InheritDisplayProperties Returns or sets the inherit display properties from source option
MakePositionIndependent Returns or sets the makepositionindependent
ParentFeatureInternal Returns or sets whether or not the latest timestamped parent feature of this feature should be made internal
ParentPart Returns or sets the source part type
PatchSolutionFlag Returns or sets the patch solution flag
PatchSurfaceFilename Returns or sets the patch surface filename
ReverseDirection Returns or sets the wave linked datum reverse direction
SourcePartOccurrence Returns or sets the source part occurrence
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.
CommitCreateOnTheFly Commits the feature and set create on the fly flag
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.
GetProductInterfaceObjects Gets selected product interface objects
GetSourcePartOccurrences Gets source part occurrences
GetWaveLinkInformation Prints wave browser type information about link
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
SetProductInterfaceObjects Sets selected product interface objects
SetSourcePartOccurrences Sets source part occurrences
SetSynchlinkEntry Sets Entry From SynchLink
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

WaveDatumBuilderParentPartType Enumeration enum for scope of part

Property Detail

Associative

WaveDatumBuilder.Associative

Returns or sets the associative

-------------------------------------

Getter Method

Signature Associative

Returns:
Return type:bool

New in version NX5.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature Associative

Parameters:associative (bool) –

New in version NX5.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”) OR cam_base (“CAM BASE”) OR geometric_tol (“GDT”) OR insp_programming (“INSPECTION PROGRAMMING”)

Datums

WaveDatumBuilder.Datums

Returns the datum to link

-------------------------------------

Getter Method

Signature Datums

Returns:
Return type:NXOpen.SelectObjectList

New in version NX5.0.0.

License requirements: None.

DisplayScale

WaveDatumBuilder.DisplayScale

Returns or sets the display scale

-------------------------------------

Getter Method

Signature DisplayScale

Returns:
Return type:float

New in version NX5.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature DisplayScale

Parameters:displayScale (float) –

New in version NX5.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”) OR cam_base (“CAM BASE”) OR geometric_tol (“GDT”) OR insp_programming (“INSPECTION PROGRAMMING”)

HideOriginal

WaveDatumBuilder.HideOriginal

Returns or sets the hideoriginal

-------------------------------------

Getter Method

Signature HideOriginal

Returns:
Return type:bool

New in version NX5.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature HideOriginal

Parameters:hideoriginal (bool) –

New in version NX5.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”) OR cam_base (“CAM BASE”) OR geometric_tol (“GDT”) OR insp_programming (“INSPECTION PROGRAMMING”)

InheritDisplayProperties

WaveDatumBuilder.InheritDisplayProperties

Returns or sets the inherit display properties from source option

-------------------------------------

Getter Method

Signature InheritDisplayProperties

Returns:
Return type:bool

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature InheritDisplayProperties

Parameters:inheritDisplayProperties (bool) –

New in version NX6.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”) OR cam_base (“CAM BASE”) OR geometric_tol (“GDT”) OR insp_programming (“INSPECTION PROGRAMMING”)

MakePositionIndependent

WaveDatumBuilder.MakePositionIndependent

Returns or sets the makepositionindependent

-------------------------------------

Getter Method

Signature MakePositionIndependent

Returns:
Return type:bool

New in version NX5.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature MakePositionIndependent

Parameters:makePositionIndependent (bool) –

New in version NX5.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”) OR cam_base (“CAM BASE”) OR geometric_tol (“GDT”) OR insp_programming (“INSPECTION PROGRAMMING”)

ParentPart

WaveDatumBuilder.ParentPart

Returns or sets the source part type

-------------------------------------

Getter Method

Signature ParentPart

Returns:
Return type:NXOpen.Features.WaveDatumBuilderParentPartType

New in version NX8.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ParentPart

Parameters:parentPart (NXOpen.Features.WaveDatumBuilderParentPartType) –

New in version NX8.5.0.

License requirements: solid_modeling (“SOLIDS MODELING”) OR cam_base (“CAM BASE”) OR geometric_tol (“GDT”) OR insp_programming (“INSPECTION PROGRAMMING”)

ReverseDirection

WaveDatumBuilder.ReverseDirection

Returns or sets the wave linked datum reverse direction

-------------------------------------

Getter Method

Signature ReverseDirection

Returns:
Return type:bool

New in version NX7.5.4.

License requirements: None.

-------------------------------------

Setter Method

Signature ReverseDirection

Parameters:reverseDirection (bool) –

New in version NX7.5.4.

License requirements: solid_modeling (“SOLIDS MODELING”) OR cam_base (“CAM BASE”) OR geometric_tol (“GDT”) OR insp_programming (“INSPECTION PROGRAMMING”)

SourcePartOccurrence

WaveDatumBuilder.SourcePartOccurrence

Returns or sets the source part occurrence

-------------------------------------

Getter Method

Signature SourcePartOccurrence

Returns:
Return type:NXOpen.TaggedObject

New in version NX9.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature SourcePartOccurrence

Parameters:sourcePartOcc (NXOpen.TaggedObject) –

New in version NX9.0.0.

License requirements: None.

Method Detail

CommitCreateOnTheFly

WaveDatumBuilder.CommitCreateOnTheFly

Commits the feature and set create on the fly flag

Signature CommitCreateOnTheFly()

Returns:
Return type:NXOpen.Features.Feature

New in version NX6.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”) OR cam_base (“CAM BASE”) OR geometric_tol (“GDT”) OR insp_programming (“INSPECTION PROGRAMMING”)

GetProductInterfaceObjects

WaveDatumBuilder.GetProductInterfaceObjects

Gets selected product interface objects

Signature GetProductInterfaceObjects()

Returns:items in list
Return type:list of NXOpen.Assemblies.ProductInterface.InterfaceObject

New in version NX9.0.0.

License requirements: None.

GetSourcePartOccurrences

WaveDatumBuilder.GetSourcePartOccurrences

Gets source part occurrences

Signature GetSourcePartOccurrences()

Returns:
Return type:list of NXOpen.TaggedObject

New in version NX10.0.0.

License requirements: None.

GetWaveLinkInformation

WaveDatumBuilder.GetWaveLinkInformation

Prints wave browser type information about link

Signature GetWaveLinkInformation()

Returns:a tuple
Return type:A tuple consisting of (info, xformExists, xformOrigin, xformOrientation, xformScale). info is a str. queried wave information xformExists is a bool. true if there is a transform xformOrigin is a NXOpen.Point3d. transformation origin xformOrientation is a NXOpen.Matrix3x3. transformation matrix xformScale is a float. transformation scale

New in version NX6.0.0.

License requirements: wave (“WAVE FUNCTIONALITY”)

SetProductInterfaceObjects

WaveDatumBuilder.SetProductInterfaceObjects

Sets selected product interface objects

Signature SetProductInterfaceObjects(selectedObjects)

Parameters:selectedObjects (list of NXOpen.Assemblies.ProductInterface.InterfaceObject) – items in list

New in version NX9.0.0.

License requirements: None.

SetSourcePartOccurrences

WaveDatumBuilder.SetSourcePartOccurrences

Sets source part occurrences

Signature SetSourcePartOccurrences(sourcePartOccurrences)

Parameters:sourcePartOccurrences (list of NXOpen.TaggedObject) –

New in version NX10.0.0.

License requirements: None.

SetSynchlinkEntry

WaveDatumBuilder.SetSynchlinkEntry

Sets Entry From SynchLink

Signature SetSynchlinkEntry(entryState)

Parameters:entryState (bool) –

New in version NX7.5.4.

License requirements: wave (“WAVE FUNCTIONALITY”)

Validate

WaveDatumBuilder.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.