NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::Annotations::SuppressPMIBuilder Class Reference

Represents Annotations.SuppressPMIBuilder. More...

Inheritance diagram for NXOpen::Annotations::SuppressPMIBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  SuppressionMethodType {
  SuppressionMethodTypeNone, SuppressionMethodTypeManual, SuppressionMethodTypeCreateExpressionForEach, SuppressionMethodTypeCreateSharedExpression,
  SuppressionMethodTypeSelectExpression
}
 Suppression methods. More...
 

Public Member Functions

void SelectExpression (NXOpen::Expression *expression)
 Selects the expression for suppression when the method is Select Expression
Created in NX12.0.0. More...
 
NXOpen::SelectNXObjectListSelectPMIObjects ()
 Returns the selected pmi objects
Created in NX12.0.0. More...
 
void SetSuppressionMethod (NXOpen::Annotations::SuppressPMIBuilder::SuppressionMethodType suppressionMethod)
 Sets the suppression method
Created in NX12.0.0. More...
 
NXOpen::Annotations::SuppressPMIBuilder::SuppressionMethodType SuppressionMethod ()
 Returns the suppression method
Created in NX12.0.0. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 Commits any edits that have been applied to the builder. More...
 
void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
std::vector< NXOpen::NXObject * > GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
NXOpen::NXObjectGetObject ()
 Returns the object currently being edited by this builder. More...
 
void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Represents Annotations.SuppressPMIBuilder.

This builder is used for controlling suppression of PMI objects either manually or through expressions. A suppressed PMI is not displayed and does not participate in most of the PMI operations.
To create a new instance of this class, use NXOpen::Annotations::PmiManager::CreateSuppressPmibuilder
Default values.

Property Value

SuppressionMethod

None


Created in NX12.0.0.

Member Enumeration Documentation

Suppression methods.

Enumerator
SuppressionMethodTypeNone 

Unsuppress selected PMI objects.

SuppressionMethodTypeManual 

Suppress selected PMI objects.

SuppressionMethodTypeCreateExpressionForEach 

Creates expressions for controlling the suppression of each selected PMI object.

SuppressionMethodTypeCreateSharedExpression 

Creates a single expression for controlling the suppression of the selected PMI objects and suppresses them.

SuppressionMethodTypeSelectExpression 

Allows selection of an expression to control the suppression of the selected PMI objects.

Member Function Documentation

void NXOpen::Annotations::SuppressPMIBuilder::SelectExpression ( NXOpen::Expression expression)

Selects the expression for suppression when the method is Select Expression
Created in NX12.0.0.



License requirements : None

Parameters
expressionexpression
NXOpen::SelectNXObjectList* NXOpen::Annotations::SuppressPMIBuilder::SelectPMIObjects ( )

Returns the selected pmi objects
Created in NX12.0.0.



License requirements : None

void NXOpen::Annotations::SuppressPMIBuilder::SetSuppressionMethod ( NXOpen::Annotations::SuppressPMIBuilder::SuppressionMethodType  suppressionMethod)

Sets the suppression method
Created in NX12.0.0.



License requirements : None

Parameters
suppressionMethodsuppressionmethod
NXOpen::Annotations::SuppressPMIBuilder::SuppressionMethodType NXOpen::Annotations::SuppressPMIBuilder::SuppressionMethod ( )

Returns the suppression method
Created in NX12.0.0.



License requirements : None


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