WaveQuery Class — NXOpen Python API Reference 12.0.0 documentation

# WaveQuery Class

class `NXOpen.Assemblies.``WaveQuery`

  Bases: `NXOpen.TransientObject`

  Provides information about the inter-part relations (e.g. WAVE, inter-part expressions) in a NX model.

  The returned XML string contains information from parts loaded in the NX session and from published TeamCenter data. The XML must be unmarshaled using the Browser_model_schema.xsd.The XML identifiers are valid for the life of the session and are used in sequent queries.

  For the selected parts, the queries return the first level parent (source) and child (target) parts. The object-object relations that comprise a part-part relation are included if the information is available. Each query provides a context for the meaning of a selected part. For example, the work part is the only selected part for GetWorkPartWithPartRelationsXml. However, the method GetPartsInContextAssemblyXml considers all the unique parts in the context assembly to be selected.

  Since the queries also return the first level parent and child parents, these non-selected parts could exist only in TeamCenter.

  This is an abstract class, and cannot be created.

  New in version NX6.0.0.

# Methods

Method | Description
--- | ---
AreAssemblyConstraintsDelayed | Returns true if update of assembly constraints is delayed
Dispose | Free resources associated with the instance.
GetAllSelectedPartsXml | Gets all the parts in the current selection list in the NX session.
GetChildPartRelationsXml | Gets the child parts for a given part.
GetChildRevisionOption | Returns the child revision option
GetInSessionPartsXml | Gets the parts that are in-session.
GetInterPartLinksXml | Gets the inter-part links and their sources for a given part.
GetParentPartRelationsXml | Gets the parent parts for a given part.
GetPartFeatureDependenciesXml | Gets the feature dependency lists for a fully loaded part.
GetPartPreview | Gets the part’s preview image.
GetPartsInContextAssemblyXml | Gets the parts that are in the context assembly.
GetProductInterfacesXml | Gets the product interfaces and their references for a given part.
GetReferencesToProductInterfaceXml | Gets a product interface’s referencing objects.
GetSpecifiedPartRelationsXml | Gets information about the specified parts.
GetWorkPartWithPartRelationsXml | Gets the current work part.
HandleApplicationEvents | Provides application (e.
SetChildRevisionOption | Specifies what child revisions to fetch from Teamcenter

# Method Detail

## AreAssemblyConstraintsDelayed

`WaveQuery.``AreAssemblyConstraintsDelayed`

  Returns true if update of assembly constraints is delayed

  Signature `AreAssemblyConstraintsDelayed()`

  Returns: | whether constraints are delayed
  Return type: | bool

  New in version NX7.5.0.

  License requirements: wave (“WAVE FUNCTIONALITY”)

## Dispose

`WaveQuery.``Dispose`

  Free resources associated with the instance.

  After this method is called, it is illegal to use the object. In .NET, this method is automatically called when the object is deleted by the garbage collector.

  Signature `Dispose()`

  New in version NX6.0.0.

  License requirements: None.

## GetAllSelectedPartsXml

`WaveQuery.``GetAllSelectedPartsXml`

  Gets all the parts in the current selection list in the NX session.

  Signature `GetAllSelectedPartsXml(includeOnlyWithLinks)`

  Parameters: | includeOnlyWithLinks (bool) – true if only parts that own inter-part links are returned
  Returns: | the XML
  Return type: | str

  New in version NX6.0.0.

  License requirements: wave (“WAVE FUNCTIONALITY”)

## GetChildPartRelationsXml

`WaveQuery.``GetChildPartRelationsXml`

  Gets the child parts for a given part.

  The parts are not necessarily fully loaded. The specified part and its children are considered to be “selected” parts.

  Signature `GetChildPartRelationsXml(parentPartSpec, parentPartIdentifier, walkAll)`

  Parameters:

  - parentPartSpec (str) – the part’s specification
  - parentPartIdentifier (int) – part’s in-session identifier
  - walkAll (bool) – true if children of all descendants are obtained

  Returns: | the XML
  Return type: | str

  New in version NX6.0.0.

  License requirements: wave (“WAVE FUNCTIONALITY”)

## GetChildRevisionOption

`WaveQuery.``GetChildRevisionOption`

  Returns the child revision option

  Signature `GetChildRevisionOption()`

  Returns: | the child revision option that is currently set
  Return type: | `NXOpen.Assemblies.AssembliesChildRevisionOptions`

  New in version NX8.5.0.

  License requirements: wave (“WAVE FUNCTIONALITY”)

## GetInSessionPartsXml

`WaveQuery.``GetInSessionPartsXml`

  Gets the parts that are in-session.

  The parts are not necessarily fully loaded.

  Signature `GetInSessionPartsXml(includeOnlyWithLinks)`

  Parameters: | includeOnlyWithLinks (bool) – true if only parts that own inter-part links are returned
  Returns: | the XML
  Return type: | str

  New in version NX6.0.0.

  License requirements: wave (“WAVE FUNCTIONALITY”)

## GetInterPartLinksXml

`WaveQuery.``GetInterPartLinksXml`

  Gets the inter-part links and their sources for a given part.

  The owning part is the “selected” part.

  Signature `GetInterPartLinksXml(partSpec, partIdentifier)`

  Parameters:

  - partSpec (str) – the part’s specification
  - partIdentifier (int) – part’s in-session identifier

  Returns: | the XML
  Return type: | str

  New in version NX6.0.0.

  License requirements: wave (“WAVE FUNCTIONALITY”)

## GetParentPartRelationsXml

`WaveQuery.``GetParentPartRelationsXml`

  Gets the parent parts for a given part.

  The parts are not necessarily fully loaded. The specified part and its parents are considered to be “selected” parts.

  Signature `GetParentPartRelationsXml(childPartSpec, childPartIdentifier, walkAll)`

  Parameters:

  - childPartSpec (str) – the part’s specification
  - childPartIdentifier (int) – part’s in-session identifier
  - walkAll (bool) – true if parents of all ancestors are obtained

  Returns: | the XML
  Return type: | str

  New in version NX6.0.0.

  License requirements: wave (“WAVE FUNCTIONALITY”)

## GetPartFeatureDependenciesXml

`WaveQuery.``GetPartFeatureDependenciesXml`

  Gets the feature dependency lists for a fully loaded part.

  Signature `GetPartFeatureDependenciesXml(partSpec, partIdentifier)`

  Parameters:

  - partSpec (str) – the part’s specification
  - partIdentifier (int) – part’s in-session identifier

  Returns: | the XML
  Return type: | str

  New in version NX6.0.0.

  License requirements: wave (“WAVE FUNCTIONALITY”)

## GetPartPreview

`WaveQuery.``GetPartPreview`

  Gets the part’s preview image.

  Signature `GetPartPreview(partSpec, partIdentifier)`

  Parameters:

  - partSpec (str) – the part’s specification
  - partIdentifier (int) – part’s in-session identifier

  Returns: | a tuple
  Return type: | A tuple consisting of (height, width, pixels) height is a int. height of preview image width is a int. width of preview image pixels is a list of int. the pixels

  New in version NX6.0.0.

  License requirements: wave (“WAVE FUNCTIONALITY”)

## GetPartsInContextAssemblyXml

`WaveQuery.``GetPartsInContextAssemblyXml`

  Gets the parts that are in the context assembly.

  The parts are not necessarily fully loaded.

  Signature `GetPartsInContextAssemblyXml(includeOnlyWithLinks)`

  Parameters: | includeOnlyWithLinks (bool) – true if only parts that own inter-part links are returned
  Returns: | the XML
  Return type: | str

  New in version NX6.0.0.

  License requirements: wave (“WAVE FUNCTIONALITY”)

## GetProductInterfacesXml

`WaveQuery.``GetProductInterfacesXml`

  Gets the product interfaces and their references for a given part.

  The owning part is the “selected” part.

  Signature `GetProductInterfacesXml(partSpec, partIdentifier)`

  Parameters:

  - partSpec (str) – the part’s specification
  - partIdentifier (int) – part’s in-session identifier

  Returns: | the XML
  Return type: | str

  New in version NX6.0.0.

  License requirements: wave (“WAVE FUNCTIONALITY”)

## GetReferencesToProductInterfaceXml

`WaveQuery.``GetReferencesToProductInterfaceXml`

  Gets a product interface’s referencing objects.

  The owning part is the “selected” part.

  Signature `GetReferencesToProductInterfaceXml(owningPartSpec, owningPartIdentifier, prodintHandle, prodintIdentifier)`

  Parameters:

  - owningPartSpec (str) – the owning part’s specification
  - owningPartIdentifier (int) – owning part’s in-session identifier
  - prodintHandle (str) – the product interface’s handle
  - prodintIdentifier (int) – product interface’s in-session identifier

  Returns: | the XML
  Return type: | str

  New in version NX6.0.0.

  License requirements: wave (“WAVE FUNCTIONALITY”)

## GetSpecifiedPartRelationsXml

`WaveQuery.``GetSpecifiedPartRelationsXml`

  Gets information about the specified parts.

  The parts are not necessarily fully loaded.

  Signature `GetSpecifiedPartRelationsXml(partSpecs, partIdentifiers, includeOnlyWithLinks)`

  Parameters:

  - partSpecs (list of str) – the NX part specifications
  - partIdentifiers (list of int) – the NX part identifiers
  - includeOnlyWithLinks (bool) – true if only parts that own inter-part links are returned

  Returns: | the XML
  Return type: | str

  New in version NX6.0.0.

  License requirements: wave (“WAVE FUNCTIONALITY”)

## GetWorkPartWithPartRelationsXml

`WaveQuery.``GetWorkPartWithPartRelationsXml`

  Gets the current work part.

  Signature `GetWorkPartWithPartRelationsXml()`

  Returns: | the XML
  Return type: | str

  New in version NX6.0.0.

  License requirements: wave (“WAVE FUNCTIONALITY”)

## HandleApplicationEvents

`WaveQuery.``HandleApplicationEvents`

  Provides application (e.

  g. the graphical browser) event processing by NX. Some events refer to part level actions while others refer to part object level actions.

  Signature `HandleApplicationEvents(eventType, eventDescription, entitySpecs, entityIdentifiers)`

  Parameters:

  - eventType (`NXOpen.Assemblies.AssembliesEventTypes`) – type of event for processing
  - eventDescription (str) – textual description of the event for reporting
  - entitySpecs (list of str) – the NX part specifications or the handles of the objects
  - entityIdentifiers (list of int) – the NX part or object identifiers

  Returns: | the return status of this method
  Return type: | int

  New in version NX6.0.0.

  License requirements: wave (“WAVE FUNCTIONALITY”)

## SetChildRevisionOption

`WaveQuery.``SetChildRevisionOption`

  Specifies what child revisions to fetch from Teamcenter

  Signature `SetChildRevisionOption(optionType)`

  Parameters: | optionType (`NXOpen.Assemblies.AssembliesChildRevisionOptions`) – what child revisions to fetch from Teamcenter

  New in version NX8.5.0.

  License requirements: wave (“WAVE FUNCTIONALITY”)