Main Page   Class Hierarchy   Compound List   File List   Compound Members   File Members  

ICompareDocuments Class Reference

Class to compare two documents More...

#include <ICompareDocuments.h>

List of all members.

Public Methods

virtual ~ICompareDocuments ()=default
 Destructor

virtual void CompareDocument (std::string const &originalFilePath, std::string const &revisedFilePath, std::string const &outputFilePath)=0
 Perform document comparison

virtual void CreateComparativeTable (std::string const &originalFilePath, std::string const &revisedFilePath, std::string const &outputFilePath)=0
 Create comparison table

virtual ChangedRatio ParseChangedRatio (std::string const &originalFilePath, std::string const &revisedFilePath)=0
 Parsing the document changed ratio


Static Public Methods

std::unique_ptr< ICompareDocuments > create ()
 Generate an object to perform document comparison


Protected Methods

 ICompareDocuments ()=default
 Default constructor

 ICompareDocuments (const ICompareDocuments &)=delete
 Copy constructor

ICompareDocuments & operator= (const ICompareDocuments &)=delete
 Copy assignment operator

 ICompareDocuments (ICompareDocuments &&)=delete
 Move constructor

ICompareDocuments & operator= (ICompareDocuments &&)=delete
 Move assignment operator


Detailed Description

Class to compare two documents


Constructor & Destructor Documentation

ICompareDocuments::ICompareDocuments   [protected]
 

Default constructor

ICompareDocuments::ICompareDocuments const ICompareDocuments &    [protected]
 

Copy constructor

ICompareDocuments::ICompareDocuments ICompareDocuments &&    [protected]
 

Move constructor

virtual ICompareDocuments::~ICompareDocuments   [virtual]
 

Destructor


Member Function Documentation

ICompareDocuments& ICompareDocuments::operator= const ICompareDocuments &    [protected]
 

Copy assignment operator

ICompareDocuments& ICompareDocuments::operator= ICompareDocuments &&    [protected]
 

Move assignment operator

std::unique_ptr<ICompareDocuments> ICompareDocuments::create   [static]
 

Generate an object to perform document comparison

virtual void ICompareDocuments::CompareDocument std::string const &    originalFilePath,
std::string const &    revisedFilePath,
std::string const &    outputFilePath
[pure virtual]
 

Perform document comparison

Parameters:
originalFilePath - Original file path
revisedFilePath - Revised file path
outputFilePath - Output path of comparison results

virtual void ICompareDocuments::CreateComparativeTable std::string const &    originalFilePath,
std::string const &    revisedFilePath,
std::string const &    outputFilePath
[pure virtual]
 

Create comparison table

Parameters:
originalFilePath - Original file path
revisedFilePath - Revised file path
outputFilePath - Output path of comparison table

virtual ChangedRatio ICompareDocuments::ParseChangedRatio std::string const &    originalFilePath,
std::string const &    revisedFilePath
[pure virtual]
 

Parsing the document changed ratio

Parameters:
originalFilePath - Original file path
revisedFilePath - Revised file path
Returns:
Document changed ratio


The documentation for this class was generated from the following file:
Generated on 10 Apr 2023 for Word API C/C++ Interface by Doxygen 1.3-rc2