FxStdsPlugins.h

Go to the documentation of this file.

//
// (C) Copyright 2005-2025 by Graebert GmbH.
//
// Permission to use, copy, modify, and distribute this software in
// object code form for any purpose and without fee is hereby granted, 
// provided that the above copyright notice appears in all copies and 
// that both that copyright notice and the limited warranty and
// restricted rights notice below appear in all supporting 
// documentation.
//
// GRAEBERT PROVIDES THIS PROGRAM "AS IS" AND WITH ALL FAULTS. 
// GRAEBERT SPECIFICALLY DISCLAIMS ANY IMPLIED WARRANTY OF
// MERCHANTABILITY OR FITNESS FOR A PARTICULAR USE.  GRAEBERT GMBH 
// DOES NOT WARRANT THAT THE OPERATION OF THE PROGRAM WILL BE
// UNINTERRUPTED OR ERROR FREE.
 
#pragma once
 
#include "DDKERNEL.h"
 
#include "FxStdsManager.h"
#include "FxStdsFix.h"
#include "FxStdsError.h"
 
#include <OdaCommon.h>
#include <DbDatabase.h>
#include <RxObject.h>
 
#include "FxPragmaPush.h"
 
class CFxStdsManager;
 
class DDKERNEL_API CFxStdsPlugins : public OdRxObject
{
public:
    ODRX_DECLARE_MEMBERS( CFxStdsPlugins );
 
    ~CFxStdsPlugins() override   {}

    virtual void Initialize( CFxStdsManager* ) = 0;

    virtual void SetContext( OdDbObjectIdArray , bool bUseDb = true ) = 0;

    virtual void SetupForAudit( OdDbDatabasePtr pDb , CFxString szPathName , CFxStringArray stdNameArray , CFxStringArray stdPathArray ) = 0;

    virtual CFxStringArray GetObjectFilter() = 0;
 

    virtual CFxString Author() = 0;
    virtual CFxString Description() = 0;
    virtual CFxString HRef() = 0;
    virtual CFxString Name() = 0;
    virtual CFxString Version() = 0;
    virtual CFxString classId() = 0;

    virtual bool Enabled() = 0;
    virtual void setEnabled( bool ) = 0;

    virtual void Start( CFxStdsErrorPtr ) = 0;
    virtual void Next() = 0;
    virtual bool Done() = 0;

    virtual void Clear() = 0;
 
    virtual bool CheckSysvar( CFxString , bool ) = 0;
  
    virtual void FixError( CFxStdsErrorPtr , CFxStdsFixPtr , CFxString & ) = 0;

    virtual void GetAllFixes( CFxStdsErrorPtr , OdArray<CFxStdsFixPtr> &, int & ) = 0;

    virtual CFxStdsErrorPtr GetError() = 0;

    virtual void GetPropertyDiffs( CFxStdsErrorPtr , CFxStdsFixPtr , CFxStringArray &, OdArray<OdResBufPtr> &, OdArray<OdResBufPtr> &, CFxStringArray & ) = 0;

    virtual CFxStdsFixPtr GetRecommendedFix( CFxStdsErrorPtr ) = 0;
 
};
 
typedef OdSmartPtr < CFxStdsPlugins > CFxStdsPluginsPtr;
 
#include "FxPragmaPop.h"