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

Represents an object that manages PMI objects. More...

Public Member Functions

void ApplyModelViewOrder (const NXString &savedOrderName)
 Applies a saved explicit order
Created in NX9.0.0. More...
 
void ApplyModelViewOrder (const char *savedOrderName)
 Applies a saved explicit order
Created in NX9.0.0. More...
 
std::vector
< NXOpen::Annotations::Annotation * > 
CopyDisplayInstanceObjects (const std::vector< NXOpen::Annotations::Annotation * > &inputObjects, NXOpen::View *view)
 Creates copies of input PMI Display Instance objects in the part. More...
 
std::vector
< NXOpen::Annotations::Pmi * > 
CopyObjects (const std::vector< NXOpen::Annotations::Pmi * > &inputObjects)
 Creates copies of input PMI objects in the part. More...
 
NXOpen::Annotations::ArbitraryAreaSeedBuilderCreateArbitraryAreaSeedBuilder ()
 Creates a NXOpen::Annotations::ArbitraryAreaSeedBuilder. More...
 
NXOpen::Annotations::PMIExplicitOrderBuilderCreateExplicitOrderBuilder ()
 Creates a NXOpen::Annotations::PMIExplicitOrderBuilder. More...
 
NXOpen::Annotations::SuppressPMIBuilderCreateSuppressPmibuilder ()
 Creates a NXOpen::Annotations::SuppressPMIBuilder. More...
 
void CutDisplayInstanceObjects (const std::vector< NXOpen::Annotations::Annotation * > &inputObjects, const std::vector< NXOpen::View * > &cutViews, NXOpen::View *viewOfPaste)
 Cuts the input PMI Display Instance objects in the part. More...
 
void DeleteReplaceAnnotation (NXOpen::Annotations::Annotation *oldAnnotation, NXOpen::Annotations::Annotation *newAnnotation)
 Deletes or replaces one annotation with another. More...
 
NXOpen::Annotations::PmiGetDisplayInstanceParent (NXOpen::Annotations::Annotation *displayInstance)
 Returns the PMI Display Instance parent. More...
 
NXOpen::Annotations::AnnotationGetInheritParent (NXOpen::Annotations::Annotation *inheritedPmi)
 Returns the inherited PMI parent. More...
 
bool IsEffectivityFiltered (NXOpen::Annotations::Pmi *object)
 The flag indicates whether the PMI is an effectivity filtered PMI because of assembly component configuration from managed environment. More...
 
bool IsInheritedPmi (NXOpen::Annotations::Annotation *object)
 The flag indicating whether the annotation is an inherited PMI on the drawing sheet/view. More...
 
NXOpen::Annotations::PmiAttributeCollectionPmiAttributes ()
 PmiAttribute collection
Created in NX3.0.0. More...
 
NXOpen::Annotations::PmiLightweightSectionCollectionPmiLightweightSections ()
 Lightweight Section View collection
Created in NX7.5.0. More...
 
NXOpen::Annotations::PmiRegionCollectionPmiRegions ()
 Region collection
Created in NX6.0.2. More...
 
NXOpen::Annotations::PmiCollectionPmis ()
 Pmi collection
Created in NX3.0.0. More...
 
NXOpen::Annotations::PmiWaveCollectionPmiWave ()
 WAVE collection
Created in NX8.0.0. More...
 
void ResetSize ()
 Resets the size of all the PMI displayed in the part. More...
 
void Resize ()
 Resizes all PMI symbols displayed in the active view
Created in NX8.0.0. More...
 
void RestoreUnpastedObjects ()
 Restores the unpasted PMI objects in the part. More...
 
void SaveModelViewOrder (std::vector< NXString > &orderList, const NXString &saveName)
 Saves an explicit order defined by the user
Created in NX9.0.0. More...
 
void SaveModelViewOrder (std::vector< NXString > &orderList, const char *saveName)
 Saves an explicit order defined by the user
Created in NX9.0.0. More...
 
NXOpen::Annotations::SearchModelViewCollectionSearchModelViews ()
 PMI search view collection
Created in NX7.5.0. More...
 
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Represents an object that manages PMI objects.


To obtain an instance of this class, refer to NXOpen::Part

Created in NX5.0.0.

Member Function Documentation

void NXOpen::Annotations::PmiManager::ApplyModelViewOrder ( const NXString savedOrderName)

Applies a saved explicit order
Created in NX9.0.0.



License requirements : geometric_tol ("GDT")

Parameters
savedOrderNamesavedordername
void NXOpen::Annotations::PmiManager::ApplyModelViewOrder ( const char *  savedOrderName)

Applies a saved explicit order
Created in NX9.0.0.



License requirements : geometric_tol ("GDT")

Parameters
savedOrderNamesavedordername
std::vector<NXOpen::Annotations::Annotation *> NXOpen::Annotations::PmiManager::CopyDisplayInstanceObjects ( const std::vector< NXOpen::Annotations::Annotation * > &  inputObjects,
NXOpen::View view 
)

Creates copies of input PMI Display Instance objects in the part.

Only PMI Display Instance objects which can be copied in the NX user interface will be copied.
Client must perform update NXOpen::Update::DoUpdate () after calling this method.

Returns
Copies of PMI Display Instance objects
Created in NX5.0.0.

License requirements : geometric_tol ("GDT")
Parameters
inputObjectsPMI Display Instance objects to be copied
viewView in which PMI Display Instance are copied.
std::vector<NXOpen::Annotations::Pmi *> NXOpen::Annotations::PmiManager::CopyObjects ( const std::vector< NXOpen::Annotations::Pmi * > &  inputObjects)

Creates copies of input PMI objects in the part.

Only PMI objects which can be copied in the NX user interface will be copied.
Client must perform update NXOpen::Update::DoUpdate after calling this method.

Returns
Copies of PMI objects
Created in NX5.0.0.

License requirements : geometric_tol ("GDT")
Parameters
inputObjectsPMI objects to be copied
NXOpen::Annotations::ArbitraryAreaSeedBuilder* NXOpen::Annotations::PmiManager::CreateArbitraryAreaSeedBuilder ( )

Creates a NXOpen::Annotations::ArbitraryAreaSeedBuilder.

Returns

Created in NX6.0.0.

License requirements : None
NXOpen::Annotations::PMIExplicitOrderBuilder* NXOpen::Annotations::PmiManager::CreateExplicitOrderBuilder ( )

Creates a NXOpen::Annotations::PMIExplicitOrderBuilder.

Returns

Created in NX9.0.0.

License requirements : None
NXOpen::Annotations::SuppressPMIBuilder* NXOpen::Annotations::PmiManager::CreateSuppressPmibuilder ( )

Creates a NXOpen::Annotations::SuppressPMIBuilder.

Returns

Created in NX12.0.0.

License requirements : None
void NXOpen::Annotations::PmiManager::CutDisplayInstanceObjects ( const std::vector< NXOpen::Annotations::Annotation * > &  inputObjects,
const std::vector< NXOpen::View * > &  cutViews,
NXOpen::View viewOfPaste 
)

Cuts the input PMI Display Instance objects in the part.

Cut operation makes the PMI Display Instance object invisible in the view of cut and makes it visible in the view of paste. Only PMI Display Instance objects which can be cut in the NX user interface will be copied.
Client must perform update NXOpen::Update::DoUpdate () after calling this method.

Created in NX5.0.0.

License requirements : geometric_tol ("GDT")

Parameters
inputObjectsPMI Display Instance objects to be cut
cutViewsList of cut views. Each PMI Display Instance object is cut from the corresponding view in the list.
viewOfPasteView in which PMI Display Instances are pasted.
void NXOpen::Annotations::PmiManager::DeleteReplaceAnnotation ( NXOpen::Annotations::Annotation oldAnnotation,
NXOpen::Annotations::Annotation newAnnotation 
)

Deletes or replaces one annotation with another.


This will adjust the requirements ID of the annotation if one annotation replaces another. This method may be used in NX generated automation programs but it is not intended to be used in a customer written automation program.

Created in NX6.0.0.

License requirements : None

Parameters
oldAnnotationNXOpen::Annotations::Annotation Annotation or Dimension Set to be deleted
newAnnotationNXOpen::Annotations::Annotation to replace the deleted annootation, can be NULL
NXOpen::Annotations::Pmi* NXOpen::Annotations::PmiManager::GetDisplayInstanceParent ( NXOpen::Annotations::Annotation displayInstance)

Returns the PMI Display Instance parent.

The parent is the PMI Object.

Returns
Parent PMI object
Created in NX5.0.0.

License requirements : None
Parameters
displayInstancePMI Display Instance
NXOpen::Annotations::Annotation* NXOpen::Annotations::PmiManager::GetInheritParent ( NXOpen::Annotations::Annotation inheritedPmi)

Returns the inherited PMI parent.

The parent is the PMI Display Instance in modeling.

Returns
Parent PMI Display Instance
Created in NX5.0.0.

License requirements : None
Parameters
inheritedPmiInherited PMI
bool NXOpen::Annotations::PmiManager::IsEffectivityFiltered ( NXOpen::Annotations::Pmi object)

The flag indicates whether the PMI is an effectivity filtered PMI because of assembly component configuration from managed environment.

Returns

Created in NX8.5.1.

License requirements : None
Parameters
objectPMI object to examine
bool NXOpen::Annotations::PmiManager::IsInheritedPmi ( NXOpen::Annotations::Annotation object)

The flag indicating whether the annotation is an inherited PMI on the drawing sheet/view.

Inherited PMI is the associative copy of the PMI display instance in modeling.

Returns

Created in NX5.0.0.

License requirements : None
Parameters
objectAnnotation to examine
NXOpen::Annotations::PmiAttributeCollection* NXOpen::Annotations::PmiManager::PmiAttributes ( )

PmiAttribute collection
Created in NX3.0.0.


NXOpen::Annotations::PmiLightweightSectionCollection* NXOpen::Annotations::PmiManager::PmiLightweightSections ( )

Lightweight Section View collection
Created in NX7.5.0.


NXOpen::Annotations::PmiRegionCollection* NXOpen::Annotations::PmiManager::PmiRegions ( )

Region collection
Created in NX6.0.2.


NXOpen::Annotations::PmiCollection* NXOpen::Annotations::PmiManager::Pmis ( )

Pmi collection
Created in NX3.0.0.


NXOpen::Annotations::PmiWaveCollection* NXOpen::Annotations::PmiManager::PmiWave ( )

WAVE collection
Created in NX8.0.0.


void NXOpen::Annotations::PmiManager::ResetSize ( )

Resets the size of all the PMI displayed in the part.


This will restore the size of the PMI to the part default.


Created in NX11.0.0.

License requirements : geometric_tol ("GDT")

void NXOpen::Annotations::PmiManager::Resize ( )

Resizes all PMI symbols displayed in the active view
Created in NX8.0.0.



License requirements : geometric_tol ("GDT")

void NXOpen::Annotations::PmiManager::RestoreUnpastedObjects ( )

Restores the unpasted PMI objects in the part.


This method is used by NX user interface to restore PMI objects that were cut but not pasted. If called by an automation program, this method can cause unexpected results.

Created in NX5.0.0.

License requirements : geometric_tol ("GDT")

void NXOpen::Annotations::PmiManager::SaveModelViewOrder ( std::vector< NXString > &  orderList,
const NXString saveName 
)

Saves an explicit order defined by the user
Created in NX9.0.0.



License requirements : geometric_tol ("GDT")

Parameters
orderListorderlist
saveNamesavename
void NXOpen::Annotations::PmiManager::SaveModelViewOrder ( std::vector< NXString > &  orderList,
const char *  saveName 
)

Saves an explicit order defined by the user
Created in NX9.0.0.



License requirements : geometric_tol ("GDT")

Parameters
orderListorderlist
saveNamesavename
NXOpen::Annotations::SearchModelViewCollection* NXOpen::Annotations::PmiManager::SearchModelViews ( )

PMI search view collection
Created in NX7.5.0.


tag_t NXOpen::Annotations::PmiManager::Tag ( ) const

Returns the tag of this object.


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