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

IDataMerger Class Reference

Data-merge interface More...

#include <IDataMerger.h>

List of all members.

Public Methods

virtual ~IDataMerger ()=default
 Destructor

virtual std::vector< std::string > getDataMergeFields (InputParam const &input_param)=0
 Get a list of data-merge field names

virtual void execute (InputParam const &input_param, OutputParam const &output_param)=0
 Execute the data-merge to the template


Static Public Methods

std::unique_ptr< IDataMerger > create (SimpleTypeParameter simple_type_parameter)
 Generate the object that executes the simple type data-merge

std::unique_ptr< IDataMerger > create (CompoundTypeParameter compound_type_parameter)
 Generate the object that executes the compound type data-merge

std::unique_ptr< IDataMerger > create (NestedTableTypeParameter nested_table_type_parameter)
 Generate an object to perform data-merge of a nested table type


Protected Methods

 IDataMerger ()=default
 Default constructor

 IDataMerger (const IDataMerger &)=delete
 Copy constructor

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

 IDataMerger (IDataMerger &&)=delete
 Move constructor

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


Detailed Description

Data-merge interface


Constructor & Destructor Documentation

IDataMerger::IDataMerger   [protected]
 

Default constructor

IDataMerger::IDataMerger const IDataMerger &    [protected]
 

Copy constructor

IDataMerger::IDataMerger IDataMerger &&    [protected]
 

Move constructor

virtual IDataMerger::~IDataMerger   [virtual]
 

Destructor


Member Function Documentation

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

Copy assignment operator

IDataMerger& IDataMerger::operator= IDataMerger &&    [protected]
 

Move assignment operator

virtual std::vector<std::string> IDataMerger::getDataMergeFields InputParam const &    input_param [pure virtual]
 

Get a list of data-merge field names

Parameters:
input_param - Input parameter
Returns:
List of data-merge field names

std::unique_ptr<IDataMerger> IDataMerger::create SimpleTypeParameter    simple_type_parameter [static]
 

Generate the object that executes the simple type data-merge

Parameters:
simple_type_parameter - Parameter to use for the simple type data-merge
Returns:
Object that executes the simple type data-merge

std::unique_ptr<IDataMerger> IDataMerger::create CompoundTypeParameter    compound_type_parameter [static]
 

Generate the object that executes the compound type data-merge

Parameters:
compound_type_parameter - Parameter to use for the compound type data-merge
Returns:
Object that executes the compound type data-merge

std::unique_ptr<IDataMerger> IDataMerger::create NestedTableTypeParameter    nested_table_type_parameter [static]
 

Generate an object to perform data-merge of a nested table type

Parameters:
nested_table_type_parameter - Parameters used for data-merge of nested table type
Returns:
Object to perform data-merge of a nested table type

virtual void IDataMerger::execute InputParam const &    input_param,
OutputParam const &    output_param
[pure virtual]
 

Execute the data-merge to the template

Parameters:
input_param - Input parameter
output_param - Output parameter


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