OpenAB  1.0.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
OpenAB::PIMItemIndex::PIMItemCheck Struct Reference

Definition of check that will be made on PIMItemIndex instances when comparing them. Each check checks single field of PIMItem, and based on its role, detects if items are totally different, or items are modified version of the same item. More...

#include <PIMItemIndex.hpp>

Collaboration diagram for OpenAB::PIMItemIndex::PIMItemCheck:

Public Types

enum  eFieldRole { eKey, eConflict }
 

Public Member Functions

 PIMItemCheck (const std::string &name, eFieldRole role)
 Constructor. More...
 
 ~PIMItemCheck ()
 

Public Attributes

std::string fieldName
 
eFieldRole fieldRole
 
bool enabled
 

Detailed Description

Definition of check that will be made on PIMItemIndex instances when comparing them. Each check checks single field of PIMItem, and based on its role, detects if items are totally different, or items are modified version of the same item.

Member Enumeration Documentation

Enumerator
eKey 

Field is key, if it differs between PIMItemIndex they are considered as not matching

eConflict 

Field is conflict key, if it differs between PIMItemIndex it means that items are not the same

Constructor & Destructor Documentation

OpenAB::PIMItemIndex::PIMItemCheck::PIMItemCheck ( const std::string &  name,
eFieldRole  role 
)
inline

Constructor.

Parameters
[in]namename of field to be checked
[in]rolerole of field
OpenAB::PIMItemIndex::PIMItemCheck::~PIMItemCheck ( )
inline

Member Data Documentation

bool OpenAB::PIMItemIndex::PIMItemCheck::enabled
std::string OpenAB::PIMItemIndex::PIMItemCheck::fieldName
eFieldRole OpenAB::PIMItemIndex::PIMItemCheck::fieldRole

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