CFx SDK Documentation  2020SP3
FxStdsPlugins.h
Go to the documentation of this file.
1 //
2 // (C) Copyright 2005-2020 by Graebert GmbH.
3 //
4 // Permission to use, copy, modify, and distribute this software in
5 // object code form for any purpose and without fee is hereby granted,
6 // provided that the above copyright notice appears in all copies and
7 // that both that copyright notice and the limited warranty and
8 // restricted rights notice below appear in all supporting
9 // documentation.
10 //
11 // GRAEBERT PROVIDES THIS PROGRAM "AS IS" AND WITH ALL FAULTS.
12 // GRAEBERT SPECIFICALLY DISCLAIMS ANY IMPLIED WARRANTY OF
13 // MERCHANTABILITY OR FITNESS FOR A PARTICULAR USE. GRAEBERT GMBH
14 // DOES NOT WARRANT THAT THE OPERATION OF THE PROGRAM WILL BE
15 // UNINTERRUPTED OR ERROR FREE.
16 
17 #pragma once
18 
19 #include "DDKERNEL.h"
20 
21 #include "FxStdsManager.h"
22 #include "FxStdsFix.h"
23 #include "FxStdsError.h"
24 
25 #include <OdaCommon.h>
26 #include <DbDatabase.h>
27 #include <RxObject.h>
28 
29 #include "FxPragmaPush.h"
30 
31 class CFxStdsManager;
32 
34 {
35 public:
37 
38  ~CFxStdsPlugins() override {}
39 
41  virtual void Initialize( CFxStdsManager* ) = 0;
42 
48  virtual void SetContext( OdDbObjectIdArray , bool bUseDb = true ) = 0;
49 
57  virtual void SetupForAudit( OdDbDatabasePtr pDb , CFxString szPathName , CFxStringArray stdNameArray , CFxStringArray stdPathArray ) = 0;
58 
61 
62 
72  virtual CFxString Author() = 0;
73  virtual CFxString Description() = 0;
74  virtual CFxString HRef() = 0;
75  virtual CFxString Name() = 0;
76  virtual CFxString Version() = 0;
77  virtual CFxString classId() = 0;
78 
83  virtual bool Enabled() = 0;
84  virtual void setEnabled( bool ) = 0;
85 
87  virtual void Start( CFxStdsErrorPtr ) = 0;
88  virtual void Next() = 0;
89  virtual bool Done() = 0;
90 
92  virtual void Clear() = 0;
93 
94  virtual bool CheckSysvar( CFxString , bool ) = 0;
95 
102  virtual void FixError( CFxStdsErrorPtr , CFxStdsFixPtr , CFxString & ) = 0;
103 
110  virtual void GetAllFixes( CFxStdsErrorPtr , OdArray<CFxStdsFixPtr> &, int & ) = 0;
111 
113  virtual CFxStdsErrorPtr GetError() = 0;
114 
124 
130 
131 };
132 
134 
135 #include "FxPragmaPop.h"
FxStdsError.h
FxPragmaPop.h
CFxStdsPlugins::~CFxStdsPlugins
~CFxStdsPlugins() override
Definition: FxStdsPlugins.h:38
FxStdsFix.h
CFxStdsPlugins::FixError
virtual void FixError(CFxStdsErrorPtr, CFxStdsFixPtr, CFxString &)=0
CFxStdsPlugins::HRef
virtual CFxString HRef()=0
OdRxObject
Definition: RxObject.h:564
CFxStdsPlugins::CheckSysvar
virtual bool CheckSysvar(CFxString, bool)=0
DDKERNEL.h
OdArray< OdDbObjectId, OdMemoryAllocator< OdDbObjectId > >
CFxStringArray
std::vector< CFxString > CFxStringArray
Definition: FxString.h:34
CFxStdsPlugins::Description
virtual CFxString Description()=0
RxObject.h
CFxStdsPlugins::Version
virtual CFxString Version()=0
CFxStdsPlugins::setEnabled
virtual void setEnabled(bool)=0
CFxStdsPlugins::Done
virtual bool Done()=0
CFxStdsPluginsPtr
OdSmartPtr< CFxStdsPlugins > CFxStdsPluginsPtr
Definition: FxStdsPlugins.h:133
OdSmartPtr< OdDbDatabase >
CFxString
Definition: FxString.h:48
DbDatabase.h
CFxStdsPlugins::GetError
virtual CFxStdsErrorPtr GetError()=0
CFxStdsPlugins::Start
virtual void Start(CFxStdsErrorPtr)=0
OdaCommon.h
DDKERNEL_API
#define DDKERNEL_API
Definition: DDKERNEL.h:32
CFxStdsPlugins::Enabled
virtual bool Enabled()=0
CFxStdsPlugins::SetContext
virtual void SetContext(OdDbObjectIdArray, bool bUseDb=true)=0
CFxStdsPlugins::Author
virtual CFxString Author()=0
CFxStdsPlugins::GetPropertyDiffs
virtual void GetPropertyDiffs(CFxStdsErrorPtr, CFxStdsFixPtr, CFxStringArray &, OdArray< OdResBufPtr > &, OdArray< OdResBufPtr > &, CFxStringArray &)=0
CFxStdsPlugins::GetRecommendedFix
virtual CFxStdsFixPtr GetRecommendedFix(CFxStdsErrorPtr)=0
CFxStdsPlugins::GetAllFixes
virtual void GetAllFixes(CFxStdsErrorPtr, OdArray< CFxStdsFixPtr > &, int &)=0
CFxStdsPlugins::ODRX_DECLARE_MEMBERS
ODRX_DECLARE_MEMBERS(CFxStdsPlugins)
CFxStdsPlugins::GetObjectFilter
virtual CFxStringArray GetObjectFilter()=0
FxPragmaPush.h
CFxStdsPlugins
Definition: FxStdsPlugins.h:34
CFxStdsPlugins::Clear
virtual void Clear()=0
FxStdsManager.h
CFxStdsManager
Definition: FxStdsManager.h:35
CFxStdsPlugins::Name
virtual CFxString Name()=0
CFxStdsPlugins::classId
virtual CFxString classId()=0
CFxStdsPlugins::Initialize
virtual void Initialize(CFxStdsManager *)=0
CFxStdsPlugins::Next
virtual void Next()=0
CFxStdsPlugins::SetupForAudit
virtual void SetupForAudit(OdDbDatabasePtr pDb, CFxString szPathName, CFxStringArray stdNameArray, CFxStringArray stdPathArray)=0