NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::Annotations::PmiFilter Class Reference

Represents a base class for a PMI filter. More...

Inheritance diagram for NXOpen::Annotations::PmiFilter:
NXOpen::NXObject NXOpen::TaggedObject NXOpen::INXObject NXOpen::Annotations::PmiFilterByPart NXOpen::Annotations::PmiFilterByType NXOpen::Annotations::PmiFilterByView

List of all members.

Public Types

enum  ComponentMethod { ComponentMethodSelected, ComponentMethodSelectedAndChildren, ComponentMethodAll }
 Specifies the type of component method used on the associated components for display. More...
enum  FilterType { FilterTypeByType, FilterTypeByView, FilterTypeByComponent }
 Represents a type of PMI filter that can be created using the Part Navigator. More...

Public Member Functions

void ApplyToView (NXOpen::View *view)
 Applies the PMI filter to a view.
NXOpen::Annotations::PmiFilterCopy ()
 Creates a copy of the PMI filter.
void EnableInView (NXOpen::View *view, bool enabled)
 Enables or disables the PMI filter in a given view
Created in NX4.0.0.
std::vector< NXOpen::View * > GetAppliedViews ()
 Gets the views where the PMI filter is applied.
NXOpen::Annotations::PmiFilter::ComponentMethod GetComponentMethod ()
 Gets the component method of the PMI filter.
std::vector
< NXOpen::Assemblies::Component * > 
GetComponents ()
 Gets the components associated with the PMI filter.
NXOpen::Annotations::PmiFilter::FilterType GetFilterType ()
 Gets the type of PMI filter.
bool IsEnabled (NXOpen::View *view)
 Determines if the PMI filter is enabled in the view.
void RemoveFromView (NXOpen::View *view)
 Removes a PMI filter from a view.
void SetComponentMethod (NXOpen::Annotations::PmiFilter::ComponentMethod componentMethod)
 Sets the component method of the PMI filter.
void SetComponents (const std::vector< NXOpen::Assemblies::Component * > &components)
 Sets the components associated with the PMI filter.

Detailed Description

Represents a base class for a PMI filter.


Created in NX4.0.0.


Member Enumeration Documentation

Specifies the type of component method used on the associated components for display.

Enumerator:
ComponentMethodSelected 

Specifies all components will be used.

ComponentMethodSelectedAndChildren 

Specifies all components and their children will be used.

ComponentMethodAll 

Specifies all components will be used.

Represents a type of PMI filter that can be created using the Part Navigator.

Enumerator:
FilterTypeByType 

Specifies a PMI filter defined by a set of PMI types.

FilterTypeByView 

Specifies a PMI filter defined by a set of component model views.

FilterTypeByComponent 

Specifies a PMI filter defined by a set of components.


Member Function Documentation

Applies the PMI filter to a view.


Created in NX4.0.0.

License requirements : geometric_tol ("GDT")

Parameters:
viewSpecifies the model view in which the filter is to be applied

Creates a copy of the PMI filter.

Returns:

Created in NX4.0.0.

License requirements : geometric_tol ("GDT")
void NXOpen::Annotations::PmiFilter::EnableInView ( NXOpen::View view,
bool  enabled 
)

Enables or disables the PMI filter in a given view
Created in NX4.0.0.



License requirements : geometric_tol ("GDT")

Parameters:
viewSpecifies the model view in which the filter should be enabled or disabled
enabledSpecifies the flag indicating that the filter should be enabled

Gets the views where the PMI filter is applied.

Returns:

Created in NX4.0.0.

License requirements : None

Gets the component method of the PMI filter.

Returns:

Created in NX4.0.0.

License requirements : None

Gets the components associated with the PMI filter.

Returns:

Created in NX4.0.0.

License requirements : None

Gets the type of PMI filter.

Returns:

Created in NX4.0.0.

License requirements : None

Determines if the PMI filter is enabled in the view.

Returns:

Created in NX4.0.0.

License requirements : None
Parameters:
viewSpecifies the model view to query

Removes a PMI filter from a view.


Created in NX4.0.0.

License requirements : geometric_tol ("GDT")

Parameters:
viewSpecifies the model view in which the filter should be removed

Sets the component method of the PMI filter.


Created in NX4.0.0.

License requirements : geometric_tol ("GDT")

Parameters:
componentMethodcomponent method

Sets the components associated with the PMI filter.


Created in NX4.0.0.

License requirements : geometric_tol ("GDT")

Parameters:
componentscomponents

The documentation for this class was generated from the following file:
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.