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

Represents a NXOpen::Routing::CompareRunsBuilder , used to compare runs in the work part to the ones in another part, or to runs defined in xml files gathered in a folder (native mode) or on an item revision (managed mode). More...

Inheritance diagram for NXOpen::Routing::CompareRunsBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  CompareTypes { CompareTypesXml, CompareTypesPart }
 The Compare Type selection Enum. More...
 

Public Member Functions

NXOpen::Routing::CompareRunsBuilder::CompareTypes CompareTypesEnum ()
 Returns the Compare type: part or xml
Created in NX9.0.0. More...
 
NXString FilterString ()
 Returns the filter used to limit which runs are compared among those in the folder or on the item revision
Created in NX9.0.0. More...
 
NXString InputPathString ()
 Returns the full path input to the compare runs algorithm. More...
 
bool ReportDiscrepancies ()
 Returns the option to report discrepancies down to attribute level. More...
 
void SetCompareTypesEnum (NXOpen::Routing::CompareRunsBuilder::CompareTypes compareTypesEnum)
 Sets the Compare type: part or xml
Created in NX9.0.0. More...
 
void SetFilterString (const NXString &filterString)
 Sets the filter used to limit which runs are compared among those in the folder or on the item revision
Created in NX9.0.0. More...
 
void SetFilterString (const char *filterString)
 Sets the filter used to limit which runs are compared among those in the folder or on the item revision
Created in NX9.0.0. More...
 
void SetInputPathString (const NXString &filename)
 Sets the full path input to the compare runs algorithm. More...
 
void SetInputPathString (const char *filename)
 Sets the full path input to the compare runs algorithm. More...
 
void SetReportDiscrepancies (bool reportDiscrepancies)
 Sets the option to report discrepancies down to attribute level. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 Commits any edits that have been applied to the builder. More...
 
void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
std::vector< NXOpen::NXObject * > GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
NXOpen::NXObjectGetObject ()
 Returns the object currently being edited by this builder. More...
 
void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Represents a NXOpen::Routing::CompareRunsBuilder , used to compare runs in the work part to the ones in another part, or to runs defined in xml files gathered in a folder (native mode) or on an item revision (managed mode).


To create a new instance of this class, use NXOpen::Routing::RouteManager::CreateCompareRunsBuilder
Default values.

Property Value

CompareTypesEnum

Xml


Created in NX9.0.0.

Member Enumeration Documentation

The Compare Type selection Enum.

Enumerator
CompareTypesXml 

xml

CompareTypesPart 

part

Member Function Documentation

NXOpen::Routing::CompareRunsBuilder::CompareTypes NXOpen::Routing::CompareRunsBuilder::CompareTypesEnum ( )

Returns the Compare type: part or xml
Created in NX9.0.0.



License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

NXString NXOpen::Routing::CompareRunsBuilder::FilterString ( )

Returns the filter used to limit which runs are compared among those in the folder or on the item revision
Created in NX9.0.0.



License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

NXString NXOpen::Routing::CompareRunsBuilder::InputPathString ( )

Returns the full path input to the compare runs algorithm.

Can be a folder or an item revision for xml comparisons, or a part.
Created in NX9.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

bool NXOpen::Routing::CompareRunsBuilder::ReportDiscrepancies ( )

Returns the option to report discrepancies down to attribute level.


Created in NX9.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

void NXOpen::Routing::CompareRunsBuilder::SetCompareTypesEnum ( NXOpen::Routing::CompareRunsBuilder::CompareTypes  compareTypesEnum)

Sets the Compare type: part or xml
Created in NX9.0.0.



License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters
compareTypesEnumcomparetypesenum
void NXOpen::Routing::CompareRunsBuilder::SetFilterString ( const NXString filterString)

Sets the filter used to limit which runs are compared among those in the folder or on the item revision
Created in NX9.0.0.



License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters
filterStringfilterstring
void NXOpen::Routing::CompareRunsBuilder::SetFilterString ( const char *  filterString)

Sets the filter used to limit which runs are compared among those in the folder or on the item revision
Created in NX9.0.0.



License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters
filterStringfilterstring
void NXOpen::Routing::CompareRunsBuilder::SetInputPathString ( const NXString filename)

Sets the full path input to the compare runs algorithm.

Can be a folder or an item revision for xml comparisons, or a part.
Created in NX9.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters
filenamefilename
void NXOpen::Routing::CompareRunsBuilder::SetInputPathString ( const char *  filename)

Sets the full path input to the compare runs algorithm.

Can be a folder or an item revision for xml comparisons, or a part.
Created in NX9.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters
filenamefilename
void NXOpen::Routing::CompareRunsBuilder::SetReportDiscrepancies ( bool  reportDiscrepancies)

Sets the option to report discrepancies down to attribute level.


Created in NX9.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters
reportDiscrepanciesreportdiscrepancies

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