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

Inheritance diagram for NXOpen::Assemblies::WaveQuery:

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

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

NXString	GetChildPartRelationsXml (const NXString &parentPartSpec, int parentPartIdentifier, bool walkAll)
	Gets the child parts for a given part.

NXString	GetChildPartRelationsXml (const char *parentPartSpec, int parentPartIdentifier, bool walkAll)
	Gets the child parts for a given part.

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

NXString	GetInSessionPartsXml (bool includeOnlyWithLinks)
	Gets the parts that are in-session.

NXString	GetInterPartLinksXml (const NXString &partSpec, int partIdentifier)
	Gets the inter-part links and their sources for a given part.

NXString	GetInterPartLinksXml (const char *partSpec, int partIdentifier)
	Gets the inter-part links and their sources for a given part.

NXString	GetParentPartRelationsXml (const NXString &childPartSpec, int childPartIdentifier, bool walkAll)
	Gets the parent parts for a given part.

NXString	GetParentPartRelationsXml (const char *childPartSpec, int childPartIdentifier, bool walkAll)
	Gets the parent parts for a given part.

NXString	GetPartFeatureDependenciesXml (const NXString &partSpec, int partIdentifier)
	Gets the feature dependency lists for a fully loaded part.

NXString	GetPartFeatureDependenciesXml (const char *partSpec, int partIdentifier)
	Gets the feature dependency lists for a fully loaded part.

void	GetPartPreview (const NXString &partSpec, int partIdentifier, int height, int width, std::vector< int > &pixels)
	Gets the part's preview image.

void	GetPartPreview (const char partSpec, int partIdentifier, int height, int *width, std::vector< int > &pixels)
	Gets the part's preview image.

NXString	GetPartsInContextAssemblyXml (bool includeOnlyWithLinks)
	Gets the parts that are in the context assembly.

NXString	GetProductInterfacesXml (const NXString &partSpec, int partIdentifier)
	Gets the product interfaces and their references for a given part.

NXString	GetProductInterfacesXml (const char *partSpec, int partIdentifier)
	Gets the product interfaces and their references for a given part.

NXString	GetReferencesToProductInterfaceXml (const NXString &owningPartSpec, int owningPartIdentifier, const NXString &prodintHandle, int prodintIdentifier)
	Gets a product interface's referencing objects.

NXString	GetReferencesToProductInterfaceXml (const char owningPartSpec, int owningPartIdentifier, const char prodintHandle, int prodintIdentifier)
	Gets a product interface's referencing objects.

NXString	GetSpecifiedPartRelationsXml (std::vector< NXString > &partSpecs, const std::vector< int > &partIdentifiers, bool includeOnlyWithLinks)
	Gets information about the specified parts.

NXString	GetWorkPartWithPartRelationsXml ()
	Gets the current work part.

int	HandleApplicationEvents (NXOpen::Assemblies::AssembliesEventTypes eventType, const NXString &eventDescription, std::vector< NXString > &entitySpecs, const std::vector< int > &entityIdentifiers)
	Provides application (e.g.

int	HandleApplicationEvents (NXOpen::Assemblies::AssembliesEventTypes eventType, const char *eventDescription, std::vector< NXString > &entitySpecs, const std::vector< int > &entityIdentifiers)
	Provides application (e.g.

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

virtual	~WaveQuery ()
	Free resources associated with the instance.

Public Member Functions inherited from NXOpen::TransientObject
void *	GetHandle ()
	Handle of the internal object represented by this object.

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.

Constructor & Destructor Documentation

virtual NXOpen::Assemblies::WaveQuery::~WaveQuery ( )

virtual

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

Member Function Documentation

bool NXOpen::Assemblies::WaveQuery::AreAssemblyConstraintsDelayed ( )

Returns true if update of assembly constraints is delayed.

     @return  whether constraints are delayed

Created in NX7.5.0.

License requirements : wave ("WAVE FUNCTIONALITY")

NXString NXOpen::Assemblies::WaveQuery::GetAllSelectedPartsXml ( bool includeOnlyWithLinks )

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

     @return  the XML

Created in NX6.0.0.

License requirements : wave ("WAVE FUNCTIONALITY")

Parameters

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

NXString NXOpen::Assemblies::WaveQuery::GetChildPartRelationsXml	(	const NXString &	parentPartSpec,
		int	parentPartIdentifier,
		bool	walkAll
	)

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.

Returns: the XML
Created in NX6.0.0.

License requirements : wave ("WAVE FUNCTIONALITY")

Parameters

parentPartSpec	the part's specification NOTE: The full Unicode character set is not supported for this parameter.
parentPartIdentifier	part's in-session identifier
walkAll	true if children of all descendants are obtained

NXString NXOpen::Assemblies::WaveQuery::GetChildPartRelationsXml	(	const char *	parentPartSpec,
		int	parentPartIdentifier,
		bool	walkAll
	)

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.

Returns: the XML
Created in NX6.0.0.

License requirements : wave ("WAVE FUNCTIONALITY")

Parameters

parentPartSpec	the part's specification NOTE: The full Unicode character set is not supported for this parameter.
parentPartIdentifier	part's in-session identifier
walkAll	true if children of all descendants are obtained

NXOpen::Assemblies::AssembliesChildRevisionOptions NXOpen::Assemblies::WaveQuery::GetChildRevisionOption ( )

Returns the child revision option.

     @return  the child revision option that is currently set

Created in NX8.5.0.

License requirements : wave ("WAVE FUNCTIONALITY")

NXString NXOpen::Assemblies::WaveQuery::GetInSessionPartsXml ( bool includeOnlyWithLinks )

Gets the parts that are in-session.

The parts are not necessarily fully loaded.

Returns: the XML
Created in NX6.0.0.

License requirements : wave ("WAVE FUNCTIONALITY")

Parameters

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

NXString NXOpen::Assemblies::WaveQuery::GetInterPartLinksXml	(	const NXString &	partSpec,
		int	partIdentifier
	)

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

The owning part is the "selected" part.

Returns: the XML
Created in NX6.0.0.

License requirements : wave ("WAVE FUNCTIONALITY")

Parameters

partSpec	the part's specification NOTE: The full Unicode character set is not supported for this parameter.
partIdentifier	part's in-session identifier

NXString NXOpen::Assemblies::WaveQuery::GetInterPartLinksXml	(	const char *	partSpec,
		int	partIdentifier
	)

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

The owning part is the "selected" part.

Returns: the XML
Created in NX6.0.0.

License requirements : wave ("WAVE FUNCTIONALITY")

Parameters

partSpec	the part's specification NOTE: The full Unicode character set is not supported for this parameter.
partIdentifier	part's in-session identifier

NXString NXOpen::Assemblies::WaveQuery::GetParentPartRelationsXml	(	const NXString &	childPartSpec,
		int	childPartIdentifier,
		bool	walkAll
	)

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.

Returns: the XML
Created in NX6.0.0.

License requirements : wave ("WAVE FUNCTIONALITY")

Parameters

childPartSpec	the part's specification NOTE: The full Unicode character set is not supported for this parameter.
childPartIdentifier	part's in-session identifier
walkAll	true if parents of all ancestors are obtained

NXString NXOpen::Assemblies::WaveQuery::GetParentPartRelationsXml	(	const char *	childPartSpec,
		int	childPartIdentifier,
		bool	walkAll
	)

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.

Returns: the XML
Created in NX6.0.0.

License requirements : wave ("WAVE FUNCTIONALITY")

Parameters

childPartSpec	the part's specification NOTE: The full Unicode character set is not supported for this parameter.
childPartIdentifier	part's in-session identifier
walkAll	true if parents of all ancestors are obtained

NXString NXOpen::Assemblies::WaveQuery::GetPartFeatureDependenciesXml	(	const NXString &	partSpec,
		int	partIdentifier
	)

Gets the feature dependency lists for a fully loaded part.

     @return  the XML

Created in NX6.0.0.

License requirements : wave ("WAVE FUNCTIONALITY")

Parameters

partSpec	the part's specification NOTE: The full Unicode character set is not supported for this parameter.
partIdentifier	part's in-session identifier

NXString NXOpen::Assemblies::WaveQuery::GetPartFeatureDependenciesXml	(	const char *	partSpec,
		int	partIdentifier
	)

Gets the feature dependency lists for a fully loaded part.

     @return  the XML

Created in NX6.0.0.

License requirements : wave ("WAVE FUNCTIONALITY")

Parameters

partSpec	the part's specification NOTE: The full Unicode character set is not supported for this parameter.
partIdentifier	part's in-session identifier

void NXOpen::Assemblies::WaveQuery::GetPartPreview	(	const NXString &	partSpec,
		int	partIdentifier,
		int *	height,
		int *	width,
		std::vector< int > &	pixels
	)

Gets the part's preview image.

Created in NX6.0.0.

License requirements : wave ("WAVE FUNCTIONALITY")

Parameters

partSpec	the part's specification NOTE: The full Unicode character set is not supported for this parameter.
partIdentifier	part's in-session identifier
height	height of preview image
width	width of preview image
pixels	the pixels

void NXOpen::Assemblies::WaveQuery::GetPartPreview	(	const char *	partSpec,
		int	partIdentifier,
		int *	height,
		int *	width,
		std::vector< int > &	pixels
	)

Gets the part's preview image.

Created in NX6.0.0.

License requirements : wave ("WAVE FUNCTIONALITY")

Parameters

partSpec	the part's specification NOTE: The full Unicode character set is not supported for this parameter.
partIdentifier	part's in-session identifier
height	height of preview image
width	width of preview image
pixels	the pixels

NXString NXOpen::Assemblies::WaveQuery::GetPartsInContextAssemblyXml ( bool includeOnlyWithLinks )

Gets the parts that are in the context assembly.

The parts are not necessarily fully loaded.

Returns: the XML
Created in NX6.0.0.

License requirements : wave ("WAVE FUNCTIONALITY")

Parameters

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

NXString NXOpen::Assemblies::WaveQuery::GetProductInterfacesXml	(	const NXString &	partSpec,
		int	partIdentifier
	)

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

The owning part is the "selected" part.

Returns: the XML
Created in NX6.0.0.

License requirements : wave ("WAVE FUNCTIONALITY")

Parameters

partSpec	the part's specification NOTE: The full Unicode character set is not supported for this parameter.
partIdentifier	part's in-session identifier

NXString NXOpen::Assemblies::WaveQuery::GetProductInterfacesXml	(	const char *	partSpec,
		int	partIdentifier
	)

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

The owning part is the "selected" part.

Returns: the XML
Created in NX6.0.0.

License requirements : wave ("WAVE FUNCTIONALITY")

Parameters

partSpec	the part's specification NOTE: The full Unicode character set is not supported for this parameter.
partIdentifier	part's in-session identifier

NXString NXOpen::Assemblies::WaveQuery::GetReferencesToProductInterfaceXml	(	const NXString &	owningPartSpec,
		int	owningPartIdentifier,
		const NXString &	prodintHandle,
		int	prodintIdentifier
	)

Gets a product interface's referencing objects.

The owning part is the "selected" part.

Returns: the XML
Created in NX6.0.0.

License requirements : wave ("WAVE FUNCTIONALITY")

Parameters

owningPartSpec	the owning part's specification NOTE: The full Unicode character set is not supported for this parameter.
owningPartIdentifier	owning part's in-session identifier
prodintHandle	the product interface's handle NOTE: The full Unicode character set is not supported for this parameter.
prodintIdentifier	product interface's in-session identifier

NXString NXOpen::Assemblies::WaveQuery::GetReferencesToProductInterfaceXml	(	const char *	owningPartSpec,
		int	owningPartIdentifier,
		const char *	prodintHandle,
		int	prodintIdentifier
	)

Gets a product interface's referencing objects.

The owning part is the "selected" part.

Returns: the XML
Created in NX6.0.0.

License requirements : wave ("WAVE FUNCTIONALITY")

Parameters

owningPartSpec	the owning part's specification NOTE: The full Unicode character set is not supported for this parameter.
owningPartIdentifier	owning part's in-session identifier
prodintHandle	the product interface's handle NOTE: The full Unicode character set is not supported for this parameter.
prodintIdentifier	product interface's in-session identifier

NXString NXOpen::Assemblies::WaveQuery::GetSpecifiedPartRelationsXml	(	std::vector< NXString > &	partSpecs,
		const std::vector< int > &	partIdentifiers,
		bool	includeOnlyWithLinks
	)

Gets information about the specified parts.

The parts are not necessarily fully loaded.

Returns: the XML
Created in NX6.0.0.

License requirements : wave ("WAVE FUNCTIONALITY")

Parameters

partSpecs	the NX part specifications NOTE: The full Unicode character set is not supported for this parameter.
partIdentifiers	the NX part identifiers
includeOnlyWithLinks	true if only parts that own inter-part links are returned

NXString NXOpen::Assemblies::WaveQuery::GetWorkPartWithPartRelationsXml ( )

Gets the current work part.

     @return  the XML

Created in NX6.0.0.

License requirements : wave ("WAVE FUNCTIONALITY")

int NXOpen::Assemblies::WaveQuery::HandleApplicationEvents	(	NXOpen::Assemblies::AssembliesEventTypes	eventType,
		const NXString &	eventDescription,
		std::vector< NXString > &	entitySpecs,
		const std::vector< int > &	entityIdentifiers
	)

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.

Returns: the return status of this method
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 NOTE: The full Unicode character set is not supported for this parameter.
entitySpecs	the NX part specifications or the handles of the objects NOTE: The full Unicode character set is not supported for this parameter.
entityIdentifiers	the NX part or object identifiers

int NXOpen::Assemblies::WaveQuery::HandleApplicationEvents	(	NXOpen::Assemblies::AssembliesEventTypes	eventType,
		const char *	eventDescription,
		std::vector< NXString > &	entitySpecs,
		const std::vector< int > &	entityIdentifiers
	)

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.

Returns: the return status of this method
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 NOTE: The full Unicode character set is not supported for this parameter.
entitySpecs	the NX part specifications or the handles of the objects NOTE: The full Unicode character set is not supported for this parameter.
entityIdentifiers	the NX part or object identifiers

void NXOpen::Assemblies::WaveQuery::SetChildRevisionOption ( NXOpen::Assemblies::AssembliesChildRevisionOptions optionType )

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

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

Assemblies_WaveQuery.hxx

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation