OdAuditInfo.h

Go to the documentation of this file.

 
// Copyright (C) 2002-2022, Open Design Alliance (the "Alliance"). 
// All rights reserved. 
// 
// This software and its documentation and related materials are owned by 
// the Alliance. The software may only be incorporated into application 
// programs owned by members of the Alliance, subject to a signed 
// Membership Agreement and Supplemental Software License Agreement with the
// Alliance. The structure and organization of this software are the valuable  
// trade secrets of the Alliance and its suppliers. The software is also 
// protected by copyright law and international treaty provisions. Application  
// programs incorporating this software must include the following statement 
// with their copyright notices:
//   
//   This application incorporates Open Design Alliance software pursuant to a license 
//   agreement with Open Design Alliance.
//   Open Design Alliance Copyright (C) 2002-2022 by Open Design Alliance. 
//   All rights reserved.
//
// By use of this software, its documentation or related materials, you 
// acknowledge and accept the above terms.
 
 
 
 
#ifndef _OD_AUDITINFO_INCLUDED_
#define _OD_AUDITINFO_INCLUDED_
 
#include "TD_PackPush.h"
 
#include "DbRootExport.h"
#include "OdString.h"
#include "RxObject.h"
 
class OdAuditInfoImpl;
//class OdRxObject;
 
class DBROOT_EXPORT OdAuditInfo
{
public:
 
  enum PrintDest
  {
    kSilent  = 0, // None.
    kCmdLine = 1, // Command line.
    kFile    = 2, // File.
    kBoth    = 3  // Both command line and file.
  };
  struct MsgInfo
  {
    OdString strName;
    OdString strValue;
    OdString strValidation;
    OdString strDefaultValue;
    bool     bIsError;
  };
 
  OdAuditInfo();
 
  virtual ~OdAuditInfo();
 
  bool fixErrors() const;
 
  void setFixErrors(
    bool fixErrors);
 
  int numErrors() const;
 
  int numFixes() const;
 
  void errorsFound(
    int count);
 
  void errorsFixed(
    int count);
 
  void errorsSkip(
    int count);
 
  virtual void printError(
    const OdString& name,
    const OdString& value,
    const OdString& validation = OdString::kEmpty,
    const OdString& defaultValue = OdString::kEmpty );
 
  virtual void printError(
    const OdRxObject* pObject,
    const OdString& value,
    const OdString& validation = OdString::kEmpty,
    const OdString& defaultValue = OdString::kEmpty);
 
  virtual void printInfo (
    const OdString& logInfo);
 
  void requestRegen();
 
  void resetNumEntities();
 
  void incNumEntities();
 
  int numEntities();
 
  virtual const MsgInfo& getLastInfo();
 
  virtual void setLastInfo(
    MsgInfo &lastInfo);
 
  /*  If the current count of entities being maintained in the instance
      of OdAuditInfo is a multiple of 100, and msg is not NULL,
      then this function will print the string pointed to by msg
      followed by the current entity count out to the audit log file.
     void printNumEntities(const OdChar* msg);
  */
 
  void setPrintDest(
    PrintDest printDest);
 
  PrintDest  getPrintDest();
 
private:
  OdAuditInfoImpl* m_pImpl;
};
 
typedef void (*ODAUDITINFO_CALLBACK)(const OdAuditInfo*);
DBROOT_EXPORT void odrxRegisterAuditInfoDestructorCallback(const ODAUDITINFO_CALLBACK callbackFunc);
DBROOT_EXPORT void odrxUnregisterAuditInfoDestructorCallback();
 
#include "TD_PackPop.h"
 
#endif // _OD_AUDITINFO_INCLUDED_