OdFileDepMgr.h

Go to the documentation of this file.

// Copyright (C) 2002-2017, 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 Teigha(R) software pursuant to a license 
//   agreement with Open Design Alliance.
//   Teigha(R) Copyright (C) 2002-2017 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 _ODFILEDEPMGR_INCLUDED_
#define _ODFILEDEPMGR_INCLUDED_
 
#include "TD_PackPush.h"
 
#include "OdString.h"
#include "RxDictionary.h"
#include "DbExport.h"
 
class TOOLKIT_EXPORT OdFileDependencyInfo : public OdRxObject
{
protected:
  OdFileDependencyInfo();
 
public:
  ODRX_DECLARE_MEMBERS(OdFileDependencyInfo);
  virtual void copyFrom(
    const OdRxObject* pSource);
  OdString m_FullFileName;      // Full name of file.
  OdString m_FileName;          // Base name of file.
  OdString m_FoundPath;         // Path at which file was found.
  OdString m_FingerprintGuid;   // Fingerprint GUID.
  OdString m_VersionGuid;       // Version GUID.
  OdString m_Feature;           // Name of the application or *feature* that created this entry.
  bool m_bIsModified;           // Database was modified since last save.
  bool m_bAffectsGraphics;      // Entry affects the screen view.
  OdInt32 m_nIndex;             // Unique File Dependency List *index*.
  OdInt32 m_nTimeStamp;         // Seconds since 1/1/1980.
  OdInt32 m_nFileSize;          // Current File size.
  OdRefCounter m_nReferenceCount;    // Current reference count for *database*.
};
 
typedef OdSmartPtr<OdFileDependencyInfo> OdFileDependencyInfoPtr;
 
class TOOLKIT_EXPORT OdFileDependencyManager : public OdRxObject
{
public:
  ODRX_DECLARE_MEMBERS(OdFileDependencyManager);
 
  OdFileDependencyManager() {};
 
  virtual OdUInt32 createEntry(
    const OdString& feature,
    const OdString& fullFileName,
    const bool affectsGraphics = false,
    const bool noIncrement = false) = 0;
 
 
  virtual OdResult getEntry(
    const OdString& feature,
    const OdString& fullFileName,
    OdFileDependencyInfoPtr& fileInfo, 
    const bool useCachedInfo = false) = 0;
 
  virtual OdResult getEntry(
    OdUInt32 fdlIndex,
    OdFileDependencyInfoPtr& fileInfo, 
    const bool useCachedInfo = false) = 0;
 
  virtual OdResult updateEntry(
    const OdString& feature,
    const OdString& fullFileName) = 0;
  virtual OdResult updateEntry(
    OdUInt32 index) = 0;
 
  virtual OdResult eraseEntry(
    const OdString& feature,
    const OdString& fullFileName,
    const bool forceRemove = false) = 0;
 
  virtual OdResult eraseEntry(
    OdUInt32 fdlIndex,
    const bool forceRemove = false) = 0;
 
  virtual OdUInt32 countEntries() = 0;
 
  virtual void iteratorInitialize(
    const OdString& feature = OdString::kEmpty, 
    const bool modifiedOnly = false,
    const bool affectsGraphicsOnly = false,
    const bool walkXRefTree = false) = 0;
 
  virtual OdUInt32 iteratorNext() = 0;
 
  // get feature list for saving
 
  virtual void getFeatures(
    OdRxDictionaryPtr& features) = 0;
  
  virtual void clearXRefEntries() = 0;
};
 
typedef OdSmartPtr<OdFileDependencyManager> OdFileDependencyManagerPtr;
 
#include "TD_PackPop.h"
 
#endif