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

#include <FdField.h>

Inheritance diagram for OdFdFieldResult:
OdRxObject

Public Member Functions

 ODRX_DECLARE_MEMBERS (OdFdFieldResult)
 
 OdFdFieldResult ()
 
virtual void setFieldValue (const OdFieldValue *pValue)=0
 
virtual void setEvaluationStatus (OdDbField::EvalStatus errorStatus, int errorCode=0, const OdString &errorMessage=OdString())=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

This class is used by evaluators to set the evaluation status and evaluation result in a field.

Remarks
This object is passed to evaluators during compilation and evaluation. This object cannot be instantiated.

<group Other_Classes>

Definition at line 384 of file FdField.h.

Constructor & Destructor Documentation

◆ OdFdFieldResult()

OdFdFieldResult::OdFdFieldResult ( )

Member Function Documentation

◆ ODRX_DECLARE_MEMBERS()

OdFdFieldResult::ODRX_DECLARE_MEMBERS ( OdFdFieldResult  )

◆ setEvaluationStatus()

virtual void OdFdFieldResult::setEvaluationStatus ( OdDbField::EvalStatus  errorStatus,
int  errorCode = 0,
const OdString errorMessage = OdString() 
)
pure virtual

Sets the evaluation status in the field.

Parameters
errorStatus[in] Error status.
errorCode[in] Extended error code or zero for success.
errorMessage[in] Error message.

◆ setFieldValue()

virtual void OdFdFieldResult::setFieldValue ( const OdFieldValue pValue)
pure virtual

Sets the evaluation result in the field.

Parameters
pValue[in] Input evaluation to set in the field.
Remarks
If pValue is NULL, the cached evaluation is deleted.

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