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

Represents comparison result
Created in NX9.0.0. More...

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

Public Types

enum  Category {
  CategoryCreate, CategoryUpdateAttributes, CategoryUpdateParts, CategoryMove,
  CategoryDelete, CategoryCreateConflict, CategoryMoveConflict, CategoryNotFoundConflict,
  CategoryNoAction
}
 Defines categories of comparison results. More...
 

Public Member Functions

NXOpen::Mechatronics::LogicObjectConflictLogicalObject ()
 Returns the conflict logical object from the comparison result
Created in NX9.0.0. More...
 
void GetAttributes (std::vector< NXOpen::Mechatronics::ComparisonResultAttribute * > &attributes)
 Gets a list of attributes from the comparison result
Created in NX9.0.0. More...
 
void GetElectricalParts (std::vector< NXOpen::Mechatronics::ComparisonResultElectricalPart * > &electricalParts)
 Gets a list of electrical parts from the comparison result
Created in NX9.0.0. More...
 
NXOpen::Mechatronics::LogicObjectLogicalObject ()
 Returns the logical object from the comparison result
Created in NX9.0.0. More...
 
NXOpen::Mechatronics::ComparisonResult::Category ResultCategory ()
 Returns the category from the comparison result
Created in NX9.0.0. More...
 
NXString ResultName ()
 Returns the name from the comparison result
Created in NX9.0.0. More...
 
NXString ResultType ()
 Returns the type from the comparison result
Created in NX9.0.0. More...
 
void SetConflictLogicalObject (NXOpen::Mechatronics::LogicObject *conflictLogicalObject)
 Sets the conflict logical object from the comparison result
Created in NX9.0.0. More...
 
void SetLogicalObject (NXOpen::Mechatronics::LogicObject *logicalObject)
 Sets the logical object from the comparison result
Created in NX9.0.0. More...
 
void SetResultCategory (NXOpen::Mechatronics::ComparisonResult::Category category)
 Sets the category from the comparison result
Created in NX9.0.0. More...
 
virtual ~ComparisonResult ()
 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 comparison result
Created in NX9.0.0.


Member Enumeration Documentation

Defines categories of comparison results.

Enumerator
CategoryCreate 

Create category.

CategoryUpdateAttributes 

Update Attributes category.

CategoryUpdateParts 

Update Parts category.

CategoryMove 

Move category.

CategoryDelete 

Delete category.

CategoryCreateConflict 

Conflict from Create category.

CategoryMoveConflict 

Conflict from Move category.

CategoryNotFoundConflict 

Conflict due to the original logical object was deleted.

CategoryNoAction 

No Action Required.

Constructor & Destructor Documentation

virtual NXOpen::Mechatronics::ComparisonResult::~ComparisonResult ( )
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

NXOpen::Mechatronics::LogicObject* NXOpen::Mechatronics::ComparisonResult::ConflictLogicalObject ( )

Returns the conflict logical object from the comparison result
Created in NX9.0.0.



License requirements : None

void NXOpen::Mechatronics::ComparisonResult::GetAttributes ( std::vector< NXOpen::Mechatronics::ComparisonResultAttribute * > &  attributes)

Gets a list of attributes from the comparison result
Created in NX9.0.0.



License requirements : None

Parameters
attributesArray of attributes
void NXOpen::Mechatronics::ComparisonResult::GetElectricalParts ( std::vector< NXOpen::Mechatronics::ComparisonResultElectricalPart * > &  electricalParts)

Gets a list of electrical parts from the comparison result
Created in NX9.0.0.



License requirements : None

Parameters
electricalPartsArray of electrical parts
NXOpen::Mechatronics::LogicObject* NXOpen::Mechatronics::ComparisonResult::LogicalObject ( )

Returns the logical object from the comparison result
Created in NX9.0.0.



License requirements : None

NXOpen::Mechatronics::ComparisonResult::Category NXOpen::Mechatronics::ComparisonResult::ResultCategory ( )

Returns the category from the comparison result
Created in NX9.0.0.



License requirements : None

NXString NXOpen::Mechatronics::ComparisonResult::ResultName ( )

Returns the name from the comparison result
Created in NX9.0.0.



License requirements : None

NXString NXOpen::Mechatronics::ComparisonResult::ResultType ( )

Returns the type from the comparison result
Created in NX9.0.0.



License requirements : None

void NXOpen::Mechatronics::ComparisonResult::SetConflictLogicalObject ( NXOpen::Mechatronics::LogicObject conflictLogicalObject)

Sets the conflict logical object from the comparison result
Created in NX9.0.0.



License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
conflictLogicalObjectConflict logical object of comparison result
void NXOpen::Mechatronics::ComparisonResult::SetLogicalObject ( NXOpen::Mechatronics::LogicObject logicalObject)

Sets the logical object from the comparison result
Created in NX9.0.0.



License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
logicalObjectLogical object of comparison result
void NXOpen::Mechatronics::ComparisonResult::SetResultCategory ( NXOpen::Mechatronics::ComparisonResult::Category  category)

Sets the category from the comparison result
Created in NX9.0.0.



License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
categoryCategory of comparison result

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