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

Represents context of comparison results
Created in NX9.0.0. More...

Inheritance diagram for NXOpen::Mechatronics::ComparisonResultContext:
NXOpen::Mechatronics::ComparisonResultBase NXOpen::TransientObject

Public Types

enum  ResolveConflictAction { ResolveConflictActionIgnore, ResolveConflictActionCreate, ResolveConflictActionUpdate }
 Defines actions for resolving conflicts. More...
 

Public Member Functions

NXString EcadProjectId ()
 Returns the ECAD project ID from the comparison context
Created in NX9.0.0. More...
 
void GetResults (std::vector< NXOpen::Mechatronics::ComparisonResult * > &results)
 Gets a list of comparison results from the context
Created in NX9.0.0. More...
 
NXString PartName ()
 Returns the part name from the comparison context
Created in NX9.0.0. More...
 
void ResolveConflictResult (NXOpen::Mechatronics::ComparisonResult *conflictResult, NXOpen::Mechatronics::ComparisonResultContext::ResolveConflictAction action, std::vector< NXOpen::Mechatronics::ComparisonResult * > &replacements)
 Generates some new results to resolve the conflict
Created in NX9.0.0. More...
 
virtual ~ComparisonResultContext ()
 Frees the object from memory. More...
 
- Public Member Functions inherited from NXOpen::Mechatronics::ComparisonResultBase
bool Ignored ()
 Returns the flag marked if the object will be ingored when applying it to logical model
Created in NX9.0.0. More...
 
void SetIgnored (bool isIgnored)
 Sets the flag marked if the object will be ingored when applying it to logical model
Created in NX9.0.0. More...
 
virtual ~ComparisonResultBase ()
 Frees the object from memory. More...
 
- Public Member Functions inherited from NXOpen::TransientObject
void * GetHandle ()
 Handle of the internal object represented by this object. More...
 

Detailed Description

Represents context of comparison results
Created in NX9.0.0.


Member Enumeration Documentation

Defines actions for resolving conflicts.

Enumerator
ResolveConflictActionIgnore 

Ignore action.

ResolveConflictActionCreate 

Create action.

ResolveConflictActionUpdate 

Update action.

Constructor & Destructor Documentation

virtual NXOpen::Mechatronics::ComparisonResultContext::~ComparisonResultContext ( )
virtual

Frees the object from memory.

After this method is called, it is illegal to use the object. In .NET, this method is automatically called when the object is deleted by the garbage collector.
Created in NX9.0.0.

License requirements : None

Member Function Documentation

NXString NXOpen::Mechatronics::ComparisonResultContext::EcadProjectId ( )

Returns the ECAD project ID from the comparison context
Created in NX9.0.0.



License requirements : None

void NXOpen::Mechatronics::ComparisonResultContext::GetResults ( std::vector< NXOpen::Mechatronics::ComparisonResult * > &  results)

Gets a list of comparison results from the context
Created in NX9.0.0.



License requirements : None

Parameters
resultsArray of results
NXString NXOpen::Mechatronics::ComparisonResultContext::PartName ( )

Returns the part name from the comparison context
Created in NX9.0.0.



License requirements : None

void NXOpen::Mechatronics::ComparisonResultContext::ResolveConflictResult ( NXOpen::Mechatronics::ComparisonResult conflictResult,
NXOpen::Mechatronics::ComparisonResultContext::ResolveConflictAction  action,
std::vector< NXOpen::Mechatronics::ComparisonResult * > &  replacements 
)

Generates some new results to resolve the conflict
Created in NX9.0.0.



License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
conflictResultconflictresult
actionaction
replacementsArray of new generated results

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