Represents the Examine Geometry class
To create a new instance of this class, use GeometricAnalysis::AnalysisManager::CreateExamineGeometryObject

Created in NX5.0.0. More...

Inheritance diagram for NXOpen::GeometricAnalysis::ExamineGeometry:

Public Types
enum	Check { CheckObjectTiny, CheckObjectMisaligned, CheckBodyDataStructures, CheckBodyConsistency, CheckBodyFaceIntersections, CheckBodySheetBoundaries, CheckFaceSmoothness, CheckFaceSelfIntersection, CheckFaceSpikesCuts, CheckEdgeSmoothness, CheckEdgeTolerances, CheckNumChecks }
	Types of checks. More...

Public Member Functions
double	CheckCriteriaAngle ()
	Returns the Check Criteria Angle Created in NX5.0.0.

double	CheckCriteriaDistance ()
	Returns the Check Criteria Distance Created in NX5.0.0.

void	ClearAllChecks ()
	Clear or unset all types of checks Created in NX5.0.0.

void	ClearCheck (NXOpen::GeometricAnalysis::ExamineGeometry::Check check)
	Clear or unset a specified type of check Created in NX5.0.0.

void	DisplayResultsAsInfo ()
	Displays the results in the information window Created in NX5.0.0.

void	Examine ()
	Examines the geometry.

std::vector< NXOpen::NXObject * >	GetFailedObjects (NXOpen::GeometricAnalysis::ExamineGeometry::Check check)
	Returns the objects that failed a given type of check.

std::vector< int >	GetResults ()
	Returns an array containing the number of objects that failed each check.

bool	HighlightResult (NXOpen::GeometricAnalysis::ExamineGeometry::Check check)
	Highlights results of a specified type of check.

NXOpen::SelectObjectList *	ObjectsToExamine ()
	Returns the Objects to examine Created in NX5.0.0.

void	SetAllChecks ()
	Set all types of checks to examine Created in NX5.0.0.

void	SetCheck (NXOpen::GeometricAnalysis::ExamineGeometry::Check check)
	Set a specified type of check for examine geometry Created in NX5.0.0.

void	SetCheckCriteriaAngle (double angle)
	Sets the Check Criteria Angle Created in NX5.0.0.

void	SetCheckCriteriaDistance (double distance)
	Sets the Check Criteria Distance Created in NX5.0.0.

void	UnhighlightAllResults ()
	Unhighlight all results Created in NX5.0.0.

void	UnhighlightResult (NXOpen::GeometricAnalysis::ExamineGeometry::Check check)
	Unhighlight results of a specified type of check Created in NX5.0.0.

Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	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::NXObject *	GetObject ()
	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 the Examine Geometry class
To create a new instance of this class, use GeometricAnalysis::AnalysisManager::CreateExamineGeometryObject

Created in NX5.0.0.

Member Enumeration Documentation

enum NXOpen::GeometricAnalysis::ExamineGeometry::Check

Types of checks.

Enumerator:

CheckObjectTiny	ObjectTiny.
CheckObjectMisaligned	ObjectMisaligned.
CheckBodyDataStructures	BodyDataStructures.
CheckBodyConsistency	BodyConsistency.
CheckBodyFaceIntersections	BodyFaceIntersections.
CheckBodySheetBoundaries	BodySheetBoundaries.
CheckFaceSmoothness	FaceSmoothness.
CheckFaceSelfIntersection	FaceSelfIntersection.
CheckFaceSpikesCuts	FaceSpikesCuts.
CheckEdgeSmoothness	EdgeSmoothness.
CheckEdgeTolerances	EdgeTolerances.
CheckNumChecks	Number of Checks.

Member Function Documentation

double NXOpen::GeometricAnalysis::ExamineGeometry::CheckCriteriaAngle ( )

Returns the Check Criteria Angle
Created in NX5.0.0.

License requirements : None

double NXOpen::GeometricAnalysis::ExamineGeometry::CheckCriteriaDistance ( )

Returns the Check Criteria Distance
Created in NX5.0.0.

License requirements : None

void NXOpen::GeometricAnalysis::ExamineGeometry::ClearAllChecks ( )

Clear or unset all types of checks
Created in NX5.0.0.

License requirements : None

void NXOpen::GeometricAnalysis::ExamineGeometry::ClearCheck ( NXOpen::GeometricAnalysis::ExamineGeometry::Check check )

Clear or unset a specified type of check
Created in NX5.0.0.

License requirements : None

Parameters

check Type of Check

void NXOpen::GeometricAnalysis::ExamineGeometry::DisplayResultsAsInfo ( )

Displays the results in the information window
Created in NX5.0.0.

License requirements : None

void NXOpen::GeometricAnalysis::ExamineGeometry::Examine ( )

Examines the geometry.

Before calling this method, use GeometricAnalysis::ExamineGeometry::SetCheck and GeometricAnalysis::ExamineGeometry::ClearCheck to specify which checks to perform and use GeometricAnalysis::ExamineGeometry::ObjectsToExamine to specify which objects to examine. After calling this method, use GeometricAnalysis::ExamineGeometry::GetResults and GeometricAnalysis::ExamineGeometry::GetFailedObjects to get the results.
Created in NX5.0.0.

License requirements : None

std::vector<NXOpen::NXObject *> NXOpen::GeometricAnalysis::ExamineGeometry::GetFailedObjects ( NXOpen::GeometricAnalysis::ExamineGeometry::Check check )

Returns the objects that failed a given type of check.

You should call Examine before calling this method.

Returns: Objects that failed above check during Examine Geometry
Created in NX5.0.0.

License requirements : None

Parameters

check Type of Check

std::vector<int> NXOpen::GeometricAnalysis::ExamineGeometry::GetResults ( )

Returns an array containing the number of objects that failed each check.

         You should call @link Examine Examine@endlink  before calling this 
         method.    The array contains an entry for each check in the
         @link Check Check@endlink  enumeration.  The nth item in the array corresponds to
         the nth check in the @link Check Check@endlink  enumeration.  For example, the 
         first item in the array is the number of objects that failed the 
         @link GeometricAnalysis::ExamineGeometry::CheckObjectTiny GeometricAnalysis::ExamineGeometry::CheckObjectTiny@endlink  check.  
         The corresponding entry in the array will be as follows:
          <br>  <br> 
         <ul>
         <li> <b>-1</b>    errors</li>
         <li> <b>0</b>    Check not performed as check is not selected</li>
         <li> <b>-2</b>    a type of @link Check Check@endlink  is selected, no objects relevant to that type 
               of @link Check Check@endlink  are selected. For example, no bodies are selected yet the 
               @link GeometricAnalysis::ExamineGeometry::CheckBodyDataStructures GeometricAnalysis::ExamineGeometry::CheckBodyDataStructures@endlink  check is
               set or selected. </li>
         <li> <b>-3</b>    @link Check Check@endlink  not performed as other relevant @link Check Check@endlink  failed. This occurs when 
               @link GeometricAnalysis::ExamineGeometry::CheckBodyConsistency GeometricAnalysis::ExamineGeometry::CheckBodyConsistency@endlink 
               and/or @link GeometricAnalysis::ExamineGeometry::CheckBodyFaceIntersections GeometricAnalysis::ExamineGeometry::CheckBodyFaceIntersections@endlink  check is set along with 
               @link GeometricAnalysis::ExamineGeometry::CheckBodyDataStructures GeometricAnalysis::ExamineGeometry::CheckBodyDataStructures@endlink  check.
               If @link GeometricAnalysis::ExamineGeometry::CheckBodyDataStructures GeometricAnalysis::ExamineGeometry::CheckBodyDataStructures@endlink  check
               failed, @link GeometricAnalysis::ExamineGeometry::CheckBodyConsistency GeometricAnalysis::ExamineGeometry::CheckBodyConsistency@endlink 
               and/or
               @link GeometricAnalysis::ExamineGeometry::CheckBodyFaceIntersections GeometricAnalysis::ExamineGeometry::CheckBodyFaceIntersections@endlink  will
               not be performed. </li> 
       </ul>  @return  Results of Examine Geometry

Created in NX5.0.0.

License requirements : None

bool NXOpen::GeometricAnalysis::ExamineGeometry::HighlightResult ( NXOpen::GeometricAnalysis::ExamineGeometry::Check check )

Highlights results of a specified type of check.

If the highlighting fails for some of the entities, it returns True, otherwise False. Highlighting can fail when the entities are corrupt or missing the information needed to display properly. Remaining entities are highlighted when highlighting fails for some entities.

Returns: Return status of the method. If return values equals false, display was successful. if return value is true, display of some objects failed.
Created in NX5.0.0.

License requirements : None

Parameters

check Type of Check

NXOpen::SelectObjectList* NXOpen::GeometricAnalysis::ExamineGeometry::ObjectsToExamine ( )

Returns the Objects to examine
Created in NX5.0.0.

License requirements : None

void NXOpen::GeometricAnalysis::ExamineGeometry::SetAllChecks ( )

Set all types of checks to examine
Created in NX5.0.0.

License requirements : None

void NXOpen::GeometricAnalysis::ExamineGeometry::SetCheck ( NXOpen::GeometricAnalysis::ExamineGeometry::Check check )

Set a specified type of check for examine geometry
Created in NX5.0.0.

License requirements : None

Parameters

check Type of Check

void NXOpen::GeometricAnalysis::ExamineGeometry::SetCheckCriteriaAngle ( double angle )

Sets the Check Criteria Angle
Created in NX5.0.0.

License requirements : None

Parameters

angle angle

void NXOpen::GeometricAnalysis::ExamineGeometry::SetCheckCriteriaDistance ( double distance )

Sets the Check Criteria Distance
Created in NX5.0.0.

License requirements : None

Parameters

distance distance

void NXOpen::GeometricAnalysis::ExamineGeometry::UnhighlightAllResults ( )

Unhighlight all results
Created in NX5.0.0.

License requirements : None

void NXOpen::GeometricAnalysis::ExamineGeometry::UnhighlightResult ( NXOpen::GeometricAnalysis::ExamineGeometry::Check check )

Unhighlight results of a specified type of check
Created in NX5.0.0.

License requirements : None

Parameters

check Type of Check

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

GeometricAnalysis_ExamineGeometry.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation