CFx SDK Documentation 2024 SP0
Loading...
Searching...
No Matches
Public Member Functions | List of all members
CFxStdsError Class Referenceabstract

#include <FxStdsError.h>

Inheritance diagram for CFxStdsError:
OdRxObject

Public Member Functions

 ODRX_DECLARE_MEMBERS (CFxStdsError)
 
 ~CFxStdsError () override
 
virtual CFxString ApplyFix (CFxStdsFix *)=0
 
virtual void SetBadObjectId (OdDbObjectId)=0
 
virtual OdDbObjectId GetBadObjectId ()=0
 
virtual void SetBadObjectName (CFxString)=0
 
virtual CFxString GetBadObjectName ()=0
 
virtual void SetDescription (CFxString)=0
 
virtual CFxString GetDescription ()=0
 
virtual void SetErrorTypeName (CFxString)=0
 
virtual CFxString GetErrorTypeName ()=0
 
virtual void SetPlugin (CFxStdsPluginsPtr)=0
 
virtual CFxStdsPluginsPtr GetPlugins ()=0
 
virtual int PropertyCount ()=0
 
virtual OdResBufPtr GetPropertyValue (CFxString)=0
 
virtual void SetPropertyValue (CFxString, OdResBufPtr)=0
 
virtual void Reset ()=0
 
virtual void GetIgnoredByUser (bool &, CFxString &)=0
 
virtual void SetIgnoredByUser (bool, CFxString)=0
 
virtual std::map< CFxString, OdResBufPtrgetErrorMap ()=0
 
- Public Member Functions inherited from OdRxObject
 ODRX_HEAP_OPERATORS ()
 
 OdRxObject ()
 
virtual ~OdRxObject ()
 
virtual OdRxObjectqueryX (const OdRxClass *pClass) const
 
virtual OdRxObjectx (const OdRxClass *pClass) const
 
virtual OdRxClassisA () 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 OdRxClassdesc ()
 

Detailed Description

Definition at line 35 of file FxStdsError.h.

Constructor & Destructor Documentation

◆ ~CFxStdsError()

CFxStdsError::~CFxStdsError ( )
inlineoverride

Definition at line 40 of file FxStdsError.h.

Member Function Documentation

◆ ApplyFix()

virtual CFxString CFxStdsError::ApplyFix ( CFxStdsFix )
pure virtual

Description: function to apply a fix to the Current Error.

Parameters
CFxStdsFix*Pointer to Fix that is to be applied to the current Error.

◆ GetBadObjectId()

virtual OdDbObjectId CFxStdsError::GetBadObjectId ( )
pure virtual

◆ GetBadObjectName()

virtual CFxString CFxStdsError::GetBadObjectName ( )
pure virtual

◆ GetDescription()

virtual CFxString CFxStdsError::GetDescription ( )
pure virtual

◆ getErrorMap()

virtual std::map< CFxString, OdResBufPtr > CFxStdsError::getErrorMap ( )
pure virtual

Description: function to get the property map for the Current Error.

◆ GetErrorTypeName()

virtual CFxString CFxStdsError::GetErrorTypeName ( )
pure virtual

◆ GetIgnoredByUser()

virtual void CFxStdsError::GetIgnoredByUser ( bool &  ,
CFxString  
)
pure virtual

Description: function to get/set if the Current Error is ignored by the user.

Parameters
CFxStringUser name who ignored this error.
boolIs The current error ignored or not.

◆ GetPlugins()

virtual CFxStdsPluginsPtr CFxStdsError::GetPlugins ( )
pure virtual

◆ GetPropertyValue()

virtual OdResBufPtr CFxStdsError::GetPropertyValue ( CFxString  )
pure virtual

Description: function to get/set the property from/to the Current Error object.

Parameters
CFxStringProperty name.
OdResBufPtrResbuf containing property value.

◆ ODRX_DECLARE_MEMBERS()

CFxStdsError::ODRX_DECLARE_MEMBERS ( CFxStdsError  )

◆ PropertyCount()

virtual int CFxStdsError::PropertyCount ( )
pure virtual

Description: function to get the count of the properties that are to be checked in the Current Error object.

◆ Reset()

virtual void CFxStdsError::Reset ( )
pure virtual

Description: function to clear the map containing properties of the Current Error object.

◆ SetBadObjectId()

virtual void CFxStdsError::SetBadObjectId ( OdDbObjectId  )
pure virtual

Description: function to get/set the ObjectId of the Current Error.

Parameters
OdDbObjectIdObjectId of the object that has the issue.

◆ SetBadObjectName()

virtual void CFxStdsError::SetBadObjectName ( CFxString  )
pure virtual

Description: function to get/set the object name of the Current Error.

Parameters
CFxStringDXF Object Name of the object that has the issue.

◆ SetDescription()

virtual void CFxStdsError::SetDescription ( CFxString  )
pure virtual

Description: function to get/set the description of the Current Error.

Parameters
CFxStringDescription about what kind of issue an object has.

◆ SetErrorTypeName()

virtual void CFxStdsError::SetErrorTypeName ( CFxString  )
pure virtual

Description: function to get/set the description of the Current Error.

Parameters
CFxStringName of the object in the drawing.

◆ SetIgnoredByUser()

virtual void CFxStdsError::SetIgnoredByUser ( bool  ,
CFxString   
)
pure virtual

◆ SetPlugin()

virtual void CFxStdsError::SetPlugin ( CFxStdsPluginsPtr  )
pure virtual

Description: function to get/set the current plugin from/to the Current Error.

Parameters
CFxStdsPluginsPtrPointer to the plugin related tot his error.

◆ SetPropertyValue()

virtual void CFxStdsError::SetPropertyValue ( CFxString  ,
OdResBufPtr   
)
pure virtual

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