NX Open C++ Reference Guide
Classes | Public Types | Public Member Functions | List of all members
NXOpen::CAE::ModelCheck::DuplicateElementsCheckBuilder Class Reference

Represents a CAE::ModelCheck::DuplicateElementsCheckBuilder to check for duplicate elements within the candidate elements. More...

Inheritance diagram for NXOpen::CAE::ModelCheck::DuplicateElementsCheckBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Classes

struct  DisplaySettings
 Represents the display settings of duplicated elements detected. More...
 

Public Types

enum  DeletePreference { DeletePreferenceKeepHighLabel, DeletePreferenceKeepLowLabel, DeletePreferenceKeepSelected, DeletePreferenceRemoveSelected }
 Represents the duplicate elements deleting preference. More...
 

Public Member Functions

void DeleteDuplicateElements ()
 Deletes the duplicate elements and clear all cached duplicate elements in this builder.
 
NXOpen::CAE::ModelCheck::DuplicateElementsCheckBuilder::DisplaySettings DisplaySettingsData ()
 Returns the display settings for duplicate elements
Created in NX8.5.0.
 
int DuplicateElementGroupsCount ()
 Returns the duplicate elements group count, each group contains elements that are duplicates of each other and each group contains at least two duplicate elements
Created in NX8.5.0.
 
std::vector
< NXOpen::CAE::FEElement * > 
GetDuplicateElements (int groupIndex)
 Returns the duplicate elements of specified group index.
 
void IdentifyDuplicateElements ()
 Calculates to find the duplicate elements and display them in the CAE::ModelCheck::DuplicateElementsCheckBuilder::DisplaySettings .
 
NXOpen::CAE::ModelCheck::DuplicateElementsCheckBuilder::DeletePreference Preference ()
 Returns the duplicate elements deleting preference
Created in NX8.5.0.
 
NXOpen::CAE::SelectElementsBuilderPreferenceElements ()
 Returns the preference elements for keep selected and remove selected options
Created in NX8.5.0.
 
NXOpen::SelectTaggedObjectListSelectionList ()
 Returns the selected objects to be checked.
 
void SetDisplaySettingsData (const NXOpen::CAE::ModelCheck::DuplicateElementsCheckBuilder::DisplaySettings &displaySettings)
 Sets the display settings for duplicate elements
Created in NX8.5.0.
 
void SetPreference (NXOpen::CAE::ModelCheck::DuplicateElementsCheckBuilder::DeletePreference deletePreference)
 Sets the duplicate elements deleting preference
Created in NX8.5.0.
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 Commits any edits that have been applied to the builder.
 
void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder.
 
std::vector< NXOpen::NXObject * > GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit.
 
NXOpen::NXObjectGetObject ()
 Returns the object currently being edited by this builder.
 
void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results.
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called.
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t GetTag () const
 
<b>Deprecated</b>:<br>

   Use Tag instead.

 
tag_t Tag () const
 Returns the tag of this object.
 

Detailed Description

Represents a CAE::ModelCheck::DuplicateElementsCheckBuilder to check for duplicate elements within the candidate elements.

        <br> 
       Duplicate elements are elements which share the same corner nodes,but do not include
       the middle nodes.
        <br> 
       The general workflow is:
       <ol>
       <li> Set the candidate elements </li>
       <li> Set the display settings data </li>
       <li> Identify the duplicate elements </li>
       <li> Set the preference option </li>
       <li> Delete the duplicate elements </li>
       </ol>
       You can delete duplicate elements through @link Builder::Commit Builder::Commit@endlink  or
       @link CAE::ModelCheck::DuplicateElementsCheckBuilder::DeleteDuplicateElements CAE::ModelCheck::DuplicateElementsCheckBuilder::DeleteDuplicateElements@endlink .
       Commits the builder to delete duplicate elements.


Created in NX8.5.0.

Member Enumeration Documentation

Represents the duplicate elements deleting preference.

Enumerator:
DeletePreferenceKeepHighLabel 

Keep the elements with higher labels.

DeletePreferenceKeepLowLabel 

Keep the elements with lower labels.

DeletePreferenceKeepSelected 

Keep the elements specified in the element list CAE::ModelCheck::DuplicateElementsCheckBuilder::PreferenceElements and CAE::ModelCheck::DuplicateElementsCheckBuilder::SetPreferenceElements .

DeletePreferenceRemoveSelected 

Delete the elements specified in the element list CAE::ModelCheck::DuplicateElementsCheckBuilder::PreferenceElements and CAE::ModelCheck::DuplicateElementsCheckBuilder::SetPreferenceElements .

Member Function Documentation

void NXOpen::CAE::ModelCheck::DuplicateElementsCheckBuilder::DeleteDuplicateElements ( )

Deletes the duplicate elements and clear all cached duplicate elements in this builder.

           The method @link Builder::Commit Builder::Commit@endlink  will also do the same thing. Duplicate elements
           can only be deleted when the context part of this builder is a @link CAE::BaseFemPart CAE::BaseFemPart@endlink  


Created in NX8.5.0.

License requirements : nx_masterfem ("Finite Element Modeling")

NXOpen::CAE::ModelCheck::DuplicateElementsCheckBuilder::DisplaySettings NXOpen::CAE::ModelCheck::DuplicateElementsCheckBuilder::DisplaySettingsData ( )

Returns the display settings for duplicate elements
Created in NX8.5.0.



License requirements : None

int NXOpen::CAE::ModelCheck::DuplicateElementsCheckBuilder::DuplicateElementGroupsCount ( )

Returns the duplicate elements group count, each group contains elements that are duplicates of each other and each group contains at least two duplicate elements
Created in NX8.5.0.



License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

std::vector<NXOpen::CAE::FEElement *> NXOpen::CAE::ModelCheck::DuplicateElementsCheckBuilder::GetDuplicateElements ( int  groupIndex)

Returns the duplicate elements of specified group index.

Returns

Created in NX8.5.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")
Parameters
groupIndexgroupindex
void NXOpen::CAE::ModelCheck::DuplicateElementsCheckBuilder::IdentifyDuplicateElements ( )

Calculates to find the duplicate elements and display them in the CAE::ModelCheck::DuplicateElementsCheckBuilder::DisplaySettings .

           The detected duplicate elements are cached, to access the cached calculation result, you could use
           @link CAE::ModelCheck::DuplicateElementsCheckBuilder::DuplicateElementGroupsCount CAE::ModelCheck::DuplicateElementsCheckBuilder::DuplicateElementGroupsCount @endlink and @link CAE::ModelCheck::DuplicateElementsCheckBuilder::SetDuplicateElementGroupsCount CAE::ModelCheck::DuplicateElementsCheckBuilder::SetDuplicateElementGroupsCount @endlink  and
           @link CAE::ModelCheck::DuplicateElementsCheckBuilder::GetDuplicateElements CAE::ModelCheck::DuplicateElementsCheckBuilder::GetDuplicateElements@endlink . The previous
           cached data will be cleaned automatically when you start a new identification. 


Created in NX8.5.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

NXOpen::CAE::ModelCheck::DuplicateElementsCheckBuilder::DeletePreference NXOpen::CAE::ModelCheck::DuplicateElementsCheckBuilder::Preference ( )

Returns the duplicate elements deleting preference
Created in NX8.5.0.



License requirements : None

NXOpen::CAE::SelectElementsBuilder* NXOpen::CAE::ModelCheck::DuplicateElementsCheckBuilder::PreferenceElements ( )

Returns the preference elements for keep selected and remove selected options
Created in NX8.5.0.



License requirements : nx_masterfem ("Finite Element Modeling")

NXOpen::SelectTaggedObjectList* NXOpen::CAE::ModelCheck::DuplicateElementsCheckBuilder::SelectionList ( )

Returns the selected objects to be checked.

The objects must be CAE::Mesh or CAE::FEElement
Created in NX8.5.0.

License requirements : None

void NXOpen::CAE::ModelCheck::DuplicateElementsCheckBuilder::SetDisplaySettingsData ( const NXOpen::CAE::ModelCheck::DuplicateElementsCheckBuilder::DisplaySettings displaySettings)

Sets the display settings for duplicate elements
Created in NX8.5.0.



License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters
displaySettingsDisplay settings data
void NXOpen::CAE::ModelCheck::DuplicateElementsCheckBuilder::SetPreference ( NXOpen::CAE::ModelCheck::DuplicateElementsCheckBuilder::DeletePreference  deletePreference)

Sets the duplicate elements deleting preference
Created in NX8.5.0.



License requirements : nx_masterfem ("Finite Element Modeling")

Parameters
deletePreferenceDelete elements preference

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