NXOpen::Validate::XmlComparator::Options Struct Reference

Represents config options in comparison

For example:
More...

Public Member Functions
	Options (const NXString &filterFileInitial, const NXString &reportFileInitial, const NXString &logFileInitial, bool ignoreNamespacesInitial, bool ignoreUnmatchedNodesInitial, bool ignoreCommentsInitial, bool ignoreCdataInitial, bool ignorePIInitial)
	Constructor for the Options struct.

Public Attributes
NXString	FilterFile
	File specification of filter file.
bool	IgnoreCdata
	Ignores CDATA nodes in comparison.
bool	IgnoreComments
	Ignores comment nodes in comparison.
bool	IgnoreNamespaces
	Ignores namespace definition during comparison.
bool	IgnorePI
	Ignores processing instruction nodes in comparison.
bool	IgnoreUnmatchedNodes
	Ignores unmatched nodes in comparison.
NXString	LogFile
	File specification of comparison log file.
NXString	ReportFile
	File specification of report file.

Detailed Description

Represents config options in comparison

For example:

case 1: Defines filter file to control what nodes will be compared; generates comparison report and log; ignores CDATA and processing instruction nodes.

compareOptions.ReportFile           = "auto_report.html";
               compareOptions.FilterFile           = "filter.xml";
               compareOptions.LogFile              = "log.log";
               compareOptions.IgnoreNamespaces     = FALSE;
               compareOptions.IgnoreUnmatchedNodes = FALSE;
               compareOptions.IgnoreComments       = FALSE;
               compareOptions.IgnoreCdata          = TRUE;
               compareOptions.IgnorePI             = TRUE;
               CompareXmlFiles("fileOne.xml", "fileTwo.xml", compareOptions)

case 2: Compares all nodes and does not generate report file and log file.

compareOptions.ReportFile           = NULL;
               compareOptions.FilterFile           = NULL;
               compareOptions.LogFile              = NULL;
               CompareXmlFiles("fileOne.xml", "fileTwo.xml", compareOptions)

Constructor & Destructor Documentation

NXOpen::Validate::XmlComparator::Options::Options	(	const NXString &	filterFileInitial,
		const NXString &	reportFileInitial,
		const NXString &	logFileInitial,
		bool	ignoreNamespacesInitial,
		bool	ignoreUnmatchedNodesInitial,
		bool	ignoreCommentsInitial,
		bool	ignoreCdataInitial,
		bool	ignorePIInitial
	)

Constructor for the Options struct.

Parameters

filterFileInitial	File specification of filter file. The filter file defines what nodes will be compared and how to compare them. It can be NULL, which means all nodes will be compared.
reportFileInitial	File specification of report file. The report file contains the detail comparison results. It can be NULL, which means the comparator won't generate a report file.
logFileInitial	File specification of comparison log file. The log file contains detail comparison steps and comparison information. It can be NULL, which means the comparator won't generate a log file.
ignoreNamespacesInitial	Ignores namespace definition during comparison. But if the filter file has namespace definition, the comparator will ignore this option and always compare the nodes with namespace definitions. Default if false.
ignoreUnmatchedNodesInitial	Ignores unmatched nodes in comparison. Default is false.
ignoreCommentsInitial	Ignores comment nodes in comparison. Default is false.
ignoreCdataInitial	Ignores CDATA nodes in comparison. Default is false.
ignorePIInitial	Ignores processing instruction nodes in comparison. Default is false.

Member Data Documentation

NXString NXOpen::Validate::XmlComparator::Options::FilterFile

File specification of filter file.

The filter file defines what nodes will be compared and how to compare them. It can be NULL, which means all nodes will be compared.

bool NXOpen::Validate::XmlComparator::Options::IgnoreCdata

Ignores CDATA nodes in comparison.

Default is false.

bool NXOpen::Validate::XmlComparator::Options::IgnoreComments

Ignores comment nodes in comparison.

Default is false.

bool NXOpen::Validate::XmlComparator::Options::IgnoreNamespaces

Ignores namespace definition during comparison.

But if the filter file has namespace definition, the comparator will ignore this option and always compare the nodes with namespace definitions. Default if false.

bool NXOpen::Validate::XmlComparator::Options::IgnorePI

Ignores processing instruction nodes in comparison.

Default is false.

bool NXOpen::Validate::XmlComparator::Options::IgnoreUnmatchedNodes

Ignores unmatched nodes in comparison.

Default is false.

NXString NXOpen::Validate::XmlComparator::Options::LogFile

File specification of comparison log file.

The log file contains detail comparison steps and comparison information. It can be NULL, which means the comparator won't generate a log file.

NXString NXOpen::Validate::XmlComparator::Options::ReportFile

File specification of report file.

The report file contains the detail comparison results. It can be NULL, which means the comparator won't generate a report file.

---

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

• Validate_XmlComparator.hxx