Provides information about the inter-part relations (e.g. More...

Inheritance diagram for NXOpen.Assemblies.WaveQuery:

Public Member Functions
unsafe bool	AreAssemblyConstraintsDelayed ()
	Returns true if update of assembly constraints is delayed More...

unsafe string	GetAllSelectedPartsXml (bool includeOnlyWithLinks)
	Gets all the parts in the current selection list in the NX session. More...

unsafe string	GetChildPartRelationsXml (string parentPartSpec, int parentPartIdentifier, bool walkAll)
	Gets the child parts for a given part. More...

unsafe NXOpen.Assemblies.AssembliesChildRevisionOptions	GetChildRevisionOption ()
	Returns the child revision option More...

unsafe bool	GetIncludeTeamcenterRelations ()
	Gets whether or not to include teamcenter relations. More...

unsafe string	GetInSessionPartsXml (bool includeOnlyWithLinks)
	Gets the parts that are in-session. More...

unsafe string	GetInterPartLinksXml (string partSpec, int partIdentifier)
	Gets the inter-part links and their sources for a given part. More...

unsafe string	GetParentPartRelationsXml (string childPartSpec, int childPartIdentifier, bool walkAll)
	Gets the parent parts for a given part. More...

unsafe string	GetPartFeatureDependenciesXml (string partSpec, int partIdentifier)
	Gets the feature dependency lists for a fully loaded part. More...

unsafe void	GetPartPreview (string partSpec, int partIdentifier, out int height, out int width, out int[] pixels)
	Gets the part's preview image. More...

unsafe string	GetPartsInContextAssemblyXml (bool includeOnlyWithLinks)
	Gets the parts that are in the context assembly. More...

unsafe string	GetProductInterfacesXml (string partSpec, int partIdentifier)
	Gets the product interfaces and their references for a given part. More...

unsafe bool	GetQueryProductInterfaces ()
	Gets whether or not to query product interaces from TC. More...

unsafe string	GetReferencesToProductInterfaceXml (string owningPartSpec, int owningPartIdentifier, string prodintHandle, int prodintIdentifier)
	Gets a product interface's referencing objects. More...

unsafe string	GetSpecifiedPartRelationsXml (string[] partSpecs, int[] partIdentifiers, bool includeOnlyWithLinks)
	Gets information about the specified parts. More...

unsafe string	GetSpecifiedPartRelationsXml (string[] partSpecs, int[] partIdentifiers, bool includeOnlyWithLinks, bool forceQuery)
	Gets information about the specified parts. More...

unsafe string	GetWorkPartWithPartRelationsXml ()
	Gets the current work part. More...

unsafe int	HandleApplicationEvents (NXOpen.Assemblies.AssembliesEventTypes eventType, string eventDescription, string[] entitySpecs, int[] entityIdentifiers)
	Provides application (e. More...

unsafe void	SetChildRevisionOption (NXOpen.Assemblies.AssembliesChildRevisionOptions optionType)
	Specifies what child revisions to fetch from Teamcenter More...

unsafe void	SetIncludeTeamcenterRelations (bool includeTeamcenterRelations)
	Sets whether or not to include teamcenter relations. More...

unsafe void	SetQueryProductInterfaces (bool queryProductInterfaces)
	Sets whether or not to query product interaces from TC. More...

Public Member Functions inherited from NXOpen.TransientObject
void	Dispose ()
	Frees the object from memory. More...

void	PrintTestData (String variableName)
	<exclude> More...

void	PrintTestData (String variableName, int lineNumber)
	<exclude> More...

new string	ToString ()
	Returns a String that represents the current Object. More...

Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl	AsyncProcessMessage (IMessage msg, IMessageSink replySink)
	Asynchronously processes the given message. More...

IMessage	SyncProcessMessage (IMessage msg)
	Synchronously processes the given message. More...

Protected Member Functions
override void	FreeResource ()
	Free resources associated with the instance. More...

Additional Inherited Members
Properties inherited from NXOpen.TransientObject
IntPtr	Handle `[get]`
	Handle of the internal object represented by this object. More...

Detailed Description

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.

Created in NX6.0.0

Member Function Documentation

unsafe bool NXOpen.Assemblies.WaveQuery.AreAssemblyConstraintsDelayed ( )

inline

Returns true if update of assembly constraints is delayed

Created in NX7.5.0

License requirements: wave ("WAVE FUNCTIONALITY")

Returns: whether constraints are delayed

override void NXOpen.Assemblies.WaveQuery.FreeResource ( )

inlineprotectedvirtual

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.

Created in NX6.0.0

License requirements: None.

Implements NXOpen.TransientObject.

unsafe string NXOpen.Assemblies.WaveQuery.GetAllSelectedPartsXml ( bool includeOnlyWithLinks )

inline

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

Created in NX6.0.0

License requirements: wave ("WAVE FUNCTIONALITY")

Parameters

includeOnlyWithLinks true if only parts that own inter-part links are returned

Returns: the XML

unsafe string NXOpen.Assemblies.WaveQuery.GetChildPartRelationsXml	(	string	parentPartSpec,
		int	parentPartIdentifier,
		bool	walkAll
	)

inline

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.

Created in NX6.0.0

License requirements: wave ("WAVE FUNCTIONALITY")

Parameters

parentPartSpec	the part's specification
parentPartIdentifier	part's in-session identifier
walkAll	true if children of all descendants are obtained

Returns: the XML

unsafe NXOpen.Assemblies.AssembliesChildRevisionOptions NXOpen.Assemblies.WaveQuery.GetChildRevisionOption ( )

inline

Returns the child revision option

Created in NX8.5.0

License requirements: wave ("WAVE FUNCTIONALITY")

Returns: the child revision option that is currently set

unsafe bool NXOpen.Assemblies.WaveQuery.GetIncludeTeamcenterRelations ( )

inline

Gets whether or not to include teamcenter relations.

Created in NX12.0.1

License requirements: wave ("WAVE FUNCTIONALITY")

Returns: whether or not to include teamcenter relations

unsafe string NXOpen.Assemblies.WaveQuery.GetInSessionPartsXml ( bool includeOnlyWithLinks )

inline

Gets the parts that are in-session.

The parts are not necessarily fully loaded.

Created in NX6.0.0

License requirements: wave ("WAVE FUNCTIONALITY")

Parameters

includeOnlyWithLinks true if only parts that own inter-part links are returned

Returns: the XML

unsafe string NXOpen.Assemblies.WaveQuery.GetInterPartLinksXml	(	string	partSpec,
		int	partIdentifier
	)

inline

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

The owning part is the "selected" part.

Created in NX6.0.0

License requirements: wave ("WAVE FUNCTIONALITY")

Parameters

partSpec	the part's specification
partIdentifier	part's in-session identifier

Returns: the XML

unsafe string NXOpen.Assemblies.WaveQuery.GetParentPartRelationsXml	(	string	childPartSpec,
		int	childPartIdentifier,
		bool	walkAll
	)

inline

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.

Created in NX6.0.0

License requirements: wave ("WAVE FUNCTIONALITY")

Parameters

childPartSpec	the part's specification
childPartIdentifier	part's in-session identifier
walkAll	true if parents of all ancestors are obtained

Returns: the XML

unsafe string NXOpen.Assemblies.WaveQuery.GetPartFeatureDependenciesXml	(	string	partSpec,
		int	partIdentifier
	)

inline

Gets the feature dependency lists for a fully loaded part.

Created in NX6.0.0

License requirements: wave ("WAVE FUNCTIONALITY")

Parameters

partSpec	the part's specification
partIdentifier	part's in-session identifier

Returns: the XML

unsafe void NXOpen.Assemblies.WaveQuery.GetPartPreview	(	string	partSpec,
		int	partIdentifier,
		out int	height,
		out int	width,
		out int[]	pixels
	)

inline

Gets the part's preview image.

Created in NX6.0.0

License requirements: wave ("WAVE FUNCTIONALITY")

Parameters

partSpec	the part's specification
partIdentifier	part's in-session identifier
height	height of preview image
width	width of preview image
pixels	the pixels

unsafe string NXOpen.Assemblies.WaveQuery.GetPartsInContextAssemblyXml ( bool includeOnlyWithLinks )

inline

Gets the parts that are in the context assembly.

The parts are not necessarily fully loaded.

Created in NX6.0.0

License requirements: wave ("WAVE FUNCTIONALITY")

Parameters

includeOnlyWithLinks true if only parts that own inter-part links are returned

Returns: the XML

unsafe string NXOpen.Assemblies.WaveQuery.GetProductInterfacesXml	(	string	partSpec,
		int	partIdentifier
	)

inline

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

The owning part is the "selected" part.

Created in NX6.0.0

License requirements: wave ("WAVE FUNCTIONALITY")

Parameters

partSpec	the part's specification
partIdentifier	part's in-session identifier

Returns: the XML

unsafe bool NXOpen.Assemblies.WaveQuery.GetQueryProductInterfaces ( )

inline

Gets whether or not to query product interaces from TC.

Created in NX10.1.0

License requirements: wave ("WAVE FUNCTIONALITY")

Returns: whether or not to query product interaces from TC

unsafe string NXOpen.Assemblies.WaveQuery.GetReferencesToProductInterfaceXml	(	string	owningPartSpec,
		int	owningPartIdentifier,
		string	prodintHandle,
		int	prodintIdentifier
	)

inline

Gets a product interface's referencing objects.

The owning part is the "selected" part.

Created in NX6.0.0

License requirements: wave ("WAVE FUNCTIONALITY")

Parameters

owningPartSpec	the owning part's specification
owningPartIdentifier	owning part's in-session identifier
prodintHandle	the product interface's handle
prodintIdentifier	product interface's in-session identifier

Returns: the XML

unsafe string NXOpen.Assemblies.WaveQuery.GetSpecifiedPartRelationsXml	(	string[]	partSpecs,
		int[]	partIdentifiers,
		bool	includeOnlyWithLinks
	)

inline

Gets information about the specified parts.

The parts are not necessarily fully loaded.

Created in NX6.0.0

License requirements: wave ("WAVE FUNCTIONALITY")

Parameters

partSpecs	the NX part specifications
partIdentifiers	the NX part identifiers
includeOnlyWithLinks	true if only parts that own inter-part links are returned

Returns: the XML

unsafe string NXOpen.Assemblies.WaveQuery.GetSpecifiedPartRelationsXml	(	string[]	partSpecs,
		int[]	partIdentifiers,
		bool	includeOnlyWithLinks,
		bool	forceQuery
	)

inline

Gets information about the specified parts.

The parts are not necessarily fully loaded.

Created in NX12.0.1

License requirements: wave ("WAVE FUNCTIONALITY")

Parameters

partSpecs	the NX part specifications
partIdentifiers	the NX part identifiers
includeOnlyWithLinks	true if only parts that own inter-part links are returned
forceQuery	true if we are to force query

Returns: the XML

unsafe string NXOpen.Assemblies.WaveQuery.GetWorkPartWithPartRelationsXml ( )

inline

Gets the current work part.

Created in NX6.0.0

License requirements: wave ("WAVE FUNCTIONALITY")

Returns: the XML

unsafe int NXOpen.Assemblies.WaveQuery.HandleApplicationEvents	(	NXOpen.Assemblies.AssembliesEventTypes	eventType,
		string	eventDescription,
		string[]	entitySpecs,
		int[]	entityIdentifiers
	)

inline

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.

Created in NX6.0.0

License requirements: wave ("WAVE FUNCTIONALITY")

Parameters

eventType	type of event for processing
eventDescription	textual description of the event for reporting
entitySpecs	the NX part specifications or the handles of the objects
entityIdentifiers	the NX part or object identifiers

Returns: the return status of this method

unsafe void NXOpen.Assemblies.WaveQuery.SetChildRevisionOption ( NXOpen.Assemblies.AssembliesChildRevisionOptions optionType )

inline

Specifies what child revisions to fetch from Teamcenter

Created in NX8.5.0

License requirements: wave ("WAVE FUNCTIONALITY")

Parameters

optionType what child revisions to fetch from Teamcenter

unsafe void NXOpen.Assemblies.WaveQuery.SetIncludeTeamcenterRelations ( bool includeTeamcenterRelations )

inline

Sets whether or not to include teamcenter relations.

Created in NX12.0.1

License requirements: wave ("WAVE FUNCTIONALITY")

Parameters

includeTeamcenterRelations whether or not to include teamcenter relations

unsafe void NXOpen.Assemblies.WaveQuery.SetQueryProductInterfaces ( bool queryProductInterfaces )

inline

Sets whether or not to query product interaces from TC.

Created in NX10.1.0

License requirements: wave ("WAVE FUNCTIONALITY")

Parameters

queryProductInterfaces whether or not to query product interaces from TC

The documentation for this class was generated from the following file:

Assemblies_WaveQuery.cs

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation