NX Open C++ Reference Guide
Classes | Public Types | Public Member Functions | List of all members
NXOpen::Validate::XmlComparator Class Reference

Provides a generic comparator for finding differences between two XML format files. More...

Classes

struct  Options
 
Represents config options in comparison

For example:
More...
 

Public Types

enum  Result { ResultIdentical, ResultDifferent }
 Specifies result of the comparison. More...
 

Public Member Functions

NXOpen::Validate::XmlComparator::Result CompareXmlFiles (const NXString &workXmlFile, const NXString &masterXmlFile, const NXOpen::Validate::XmlComparator::Options &compareOptions)
 Compares two xml format files. More...
 
NXOpen::Validate::XmlComparator::Result CompareXmlFiles (const char *workXmlFile, const char *masterXmlFile, const NXOpen::Validate::XmlComparator::Options &compareOptions)
 Compares two xml format files. More...
 
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Provides a generic comparator for finding differences between two XML format files.

The comparator takes NXOpen::Validate::XmlComparator::Options to further control the comparison process. It returns NXOpen::Validate::XmlComparator::Result , and generates report of detailed differences in HTML file which can be viewed via web browser.


To obtain an instance of this class, refer to NXOpen::Session

Created in NX6.0.2.

Member Enumeration Documentation

Specifies result of the comparison.

Enumerator
ResultIdentical 

Represents two xml files are identical.

ResultDifferent 

Represents two xml files are different.

Member Function Documentation

NXOpen::Validate::XmlComparator::Result NXOpen::Validate::XmlComparator::CompareXmlFiles ( const NXString workXmlFile,
const NXString masterXmlFile,
const NXOpen::Validate::XmlComparator::Options compareOptions 
)

Compares two xml format files.

You can use NXOpen::Validate::XmlComparator::Options to customize the comparison process.

Returns
comparison result
Created in NX6.0.2.

License requirements : None
Parameters
workXmlFileThe first xml file to be compared
masterXmlFileThe second xml file to be compared against
compareOptionscomparison options
NXOpen::Validate::XmlComparator::Result NXOpen::Validate::XmlComparator::CompareXmlFiles ( const char *  workXmlFile,
const char *  masterXmlFile,
const NXOpen::Validate::XmlComparator::Options compareOptions 
)

Compares two xml format files.

You can use NXOpen::Validate::XmlComparator::Options to customize the comparison process.

Returns
comparison result
Created in NX6.0.2.

License requirements : None
Parameters
workXmlFileThe first xml file to be compared
masterXmlFileThe second xml file to be compared against
compareOptionscomparison options
tag_t NXOpen::Validate::XmlComparator::Tag ( ) const

Returns the tag of this object.


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