#include <FxStdsPlugins.h>

Inheritance diagram for CFxStdsPlugins:

Public Member Functions
	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

Public Member Functions inherited from OdRxObject
	ODRX_HEAP_OPERATORS ()

	OdRxObject ()

virtual	~OdRxObject ()

virtual OdRxObject *	queryX (const OdRxClass *pClass) const

virtual OdRxObject *	x (const OdRxClass *pClass) const

virtual OdRxClass *	isA () const

virtual void	addRef ()=0

virtual void	release ()=0

virtual long	numRefs () const

bool	isKindOf (const OdRxClass *pClass) const

virtual OdRxObjectPtr	clone () const

virtual void	copyFrom (const OdRxObject *pSource)

virtual OdRx::Ordering	comparedTo (const OdRxObject *pOther) const

virtual bool	isEqualTo (const OdRxObject *pOther) const

Additional Inherited Members
Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr	cast (const OdRxObject *pointer)

static OdRxClass *	desc ()

static void	rxInit ()

static void	rxUninit ()

Detailed Description

Definition at line 33 of file FxStdsPlugins.h.

Constructor & Destructor Documentation

◆ ~CFxStdsPlugins()

CFxStdsPlugins::~CFxStdsPlugins ( )

inlineoverride

Definition at line 38 of file FxStdsPlugins.h.

Member Function Documentation

◆ Author()

virtual CFxString CFxStdsPlugins::Author ( )

pure virtual

Description: Functions to get the plugin Description

CFxString Author of the plugin CFxString Description of the plugin CFxString HRef for the plugin CFxString Name of the plugin CFxString Version of the plugin CFxString Unique class ID of the plugin

◆ CheckSysvar()

virtual bool CFxStdsPlugins::CheckSysvar	(	CFxString	,
		bool	)

pure virtual

◆ classId()

virtual CFxString CFxStdsPlugins::classId ( )

pure virtual

◆ Clear()

virtual void CFxStdsPlugins::Clear ( )

pure virtual

Description: Functions to clear the array and delete the pointers created in Plugin.

◆ Description()

virtual CFxString CFxStdsPlugins::Description ( )

pure virtual

◆ Done()

virtual bool CFxStdsPlugins::Done ( )

pure virtual

◆ Enabled()

virtual bool CFxStdsPlugins::Enabled ( )

pure virtual

Description: Functions to get/set if the current plugin is enabled or not. Arguments:

Parameters

bool	Enable of Disable the current plugin.

◆ FixError()

virtual void CFxStdsPlugins::FixError	(	CFxStdsErrorPtr	,
		CFxStdsFixPtr	,
		CFxString &	)

pure virtual

Description: Functions to apply a Fix on a particular error.
Arguments:

Parameters

CFxStdsErrorPtr	ErrorPtr which is to be fixed.
CFxStdsFixPtr	FixPtr that is to be applied on the ErrorPtr.
CFxString	[output] Failure reason if any.

◆ GetAllFixes()

virtual void CFxStdsPlugins::GetAllFixes	(	CFxStdsErrorPtr	,
		OdArray< CFxStdsFixPtr > &	,
		int &	)

pure virtual

Description: Functions to apply a Fix on a particular error.
Arguments:

Parameters

CFxStdsErrorPtr	ErrorPtr for which fix array is to be found.
OdArray<CFxStdsFixPtr>	[output] Reference to Array of Fixes that can be found corresponding to this ErrorPtr.
int	[output] Recommended fix if any.

◆ GetError()

virtual CFxStdsErrorPtr CFxStdsPlugins::GetError ( )

pure virtual

Description: Functions to return the current error.

◆ GetObjectFilter()

virtual CFxStringArray CFxStdsPlugins::GetObjectFilter ( )

pure virtual

Description:
DXF name of the kind of objects for which this plugin will work.

◆ GetPropertyDiffs()

virtual void CFxStdsPlugins::GetPropertyDiffs	(	CFxStdsErrorPtr	,
		CFxStdsFixPtr	,
		CFxStringArray &	,
		OdArray< OdResBufPtr > &	,
		OdArray< OdResBufPtr > &	,
		CFxStringArray &	)

pure virtual

Description: Functions to return the property differences between current error and selected fix.
Arguments:

Parameters

CFxStdsErrorPtr	ErrorPtr for which property differences is to be found.
CFxStdsFixPtr	Current Fix with which property difference is to be done.
CFxStringArray	[output] Property name Array.
OdArray<OdResBufPtr>	[output] Resbuf values array of the different properties containing Error Values.
OdArray<OdResBufPtr>	[output] Resbuf values array of the different properties containing Fix Values.

◆ GetRecommendedFix()

virtual CFxStdsFixPtr CFxStdsPlugins::GetRecommendedFix ( CFxStdsErrorPtr )

pure virtual

Description: Functions to return the recommended fix for the given error.
Arguments:

Parameters

CFxStdsErrorPtr ErrorPtr for which Recommended FixPtr is to be found.

◆ HRef()

virtual CFxString CFxStdsPlugins::HRef ( )

pure virtual

◆ Initialize()

virtual void CFxStdsPlugins::Initialize ( CFxStdsManager * )

pure virtual

Description:
Function to initialize the plugin class with CFxStdsManager*

◆ Name()

virtual CFxString CFxStdsPlugins::Name ( )

pure virtual

◆ Next()

virtual void CFxStdsPlugins::Next ( )

pure virtual

◆ ODRX_DECLARE_MEMBERS()

CFxStdsPlugins::ODRX_DECLARE_MEMBERS ( CFxStdsPlugins )

◆ SetContext()

virtual void CFxStdsPlugins::SetContext	(	OdDbObjectIdArray	,
		bool	bUseDb = true )

pure virtual

Description:
Function to set the objectIdArray of the objects on which this plugin will work.
Arguments:

Parameters

OdDbObjectIdArray	objectIdArray of the objects on which this plugin will work.
bool	If this plugin is to operate on a single object or the complete drawing.

◆ setEnabled()

virtual void CFxStdsPlugins::setEnabled ( bool )

pure virtual

◆ SetupForAudit()

virtual void CFxStdsPlugins::SetupForAudit	(	OdDbDatabasePtr	pDb,
		CFxString	szPathName,
		CFxStringArray	stdNameArray,
		CFxStringArray	stdPathArray )

pure virtual

Description:
Function to iterate the current drawing and the dws databases to fill the contextlists and cache of fixes respectively.
Arguments:

Parameters

OdDbDatabasePtr	DatabasePtr of the current drawing.
CFxString	Name of the current drawing.
CFxStringArray	Array of the names of the dws files associated with this drawing.
CFxStringArray	Array of the paths of the dws files associated with this drawing.

◆ Start()

virtual void CFxStdsPlugins::Start ( CFxStdsErrorPtr )

pure virtual

Description: Functions to iterate through the contexts to find the errors in the drawing related to this plugin.

◆ Version()

virtual CFxString CFxStdsPlugins::Version ( )

pure virtual

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

FxStdsPlugins.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~CFxStdsPlugins()

Member Function Documentation

◆ Author()

◆ CheckSysvar()

◆ classId()

◆ Clear()

◆ Description()

◆ Done()

◆ Enabled()

◆ FixError()

◆ GetAllFixes()

◆ GetError()

◆ GetObjectFilter()

◆ GetPropertyDiffs()

◆ GetRecommendedFix()

◆ HRef()

◆ Initialize()

◆ Name()

◆ Next()

◆ ODRX_DECLARE_MEMBERS()

◆ SetContext()

◆ setEnabled()

◆ SetupForAudit()

◆ Start()

◆ Version()