OdFdFieldEnginePE Class Reference

#include <FdField.h>

Inheritance diagram for OdFdFieldEnginePE:

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdFdFieldEnginePE)
virtual OdResult	getSheetSetProperty (OdString &propValue, OdDbField *pField, OdDbDatabase *pDb)=0
virtual bool	parseObjProp (const OdString &prop, OdDbDatabase *pDb, OdDbObjectId &objId, OdString &propName)=0
virtual bool	getObjPropValue (const OdString &propName, OdInt32 paramId, const OdDbObjectId &objId, OdFdFieldResult &result)=0
virtual OdDbDatabase *	getCurrentDb ()=0
virtual OdString	getFileName (OdDbDatabase *pDb)=0
virtual void	getLispVariable (const OdString &lispVar, OdFieldValue &fValue)=0
virtual OdDbObjectId	getOwnerTable (const OdDbField *field)=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 ()

Detailed Description

This abstract class is the Field Engine Protocol Extension class. Its purpose is to provide services necessary for fields evaluation implemented at the host application level.

<group Other_Classes>

Definition at line 416 of file FdField.h.

Member Function Documentation

getCurrentDb()

virtual OdDbDatabase * OdFdFieldEnginePE::getCurrentDb ( )

pure virtual

Retrieves the current database of the host application. The purpose of the function is to allow using the current database's properties when processing NDBRO fields.

Returns

Pointer to the current OdDbDatabase object.

getFileName()

virtual OdString OdFdFieldEnginePE::getFileName ( OdDbDatabase *  pDb )

pure virtual

Returns the name of the file associated with this database object.

Parameters

pDb	[in] Database.

Returns

Name of the file associated with this database object.

Remarks

Differs from the current behavior of OdDbDatabase::getFilename(), which returns the autobackup filename, because OdDbDatabase::writeFile() always sets m_currentFileName.

getLispVariable()

virtual void OdFdFieldEnginePE::getLispVariable ( const OdString &  lispVar, OdFieldValue &  fValue  )

pure virtual

Retrieves the lisp variable value.

Parameters

lispVar	[in] Lisp variable name.
fValue	[out] Field value where the result is stored.

getObjPropValue()

virtual bool OdFdFieldEnginePE::getObjPropValue ( const OdString &  propName, OdInt32  paramId, const OdDbObjectId &  objId, OdFdFieldResult &  result  )

pure virtual

Retrieves the object property value.

Parameters

propName	[in] Property name.
paramId	[in] Optional dynamic block parameter ID (0 by default).
objId	[in] Object ID.
result	[out] Resulting property value.

Returns

True if the operation is successful, false otherwise.

getOwnerTable()

virtual OdDbObjectId OdFdFieldEnginePE::getOwnerTable ( const OdDbField *  field )

pure virtual

Returns the OdDbTable entity ID which is supposed to be the owner of the field object. Intended to be used during adding or modifying a formula field in one of table cells, while the field can be a non-database-resident.

Parameters

field

[in] Pointer to the field object.

Returns

OdDbTable entity ID.

getSheetSetProperty()

virtual OdResult OdFdFieldEnginePE::getSheetSetProperty ( OdString &  propValue, OdDbField *  pField, OdDbDatabase *  pDb  )

pure virtual

Retrieves a sheet set property value.

Parameters

propValue	[out] Resulting property value.
pField	[in] Field defining the requested property, containing at least a "SheetSetPropertyName" data item.
pDb	[in] Database.

Returns

eOk if the property was successfully retrieved to 'propValue', eInvalidInput if 'pField' does not contain data defining the requested property, eWrongDatabase if the sheet set (OdSmDatabase or OdSmSheetSet) could not be found using 'pDb'.

ODRX_DECLARE_MEMBERS()

OdFdFieldEnginePE::ODRX_DECLARE_MEMBERS

(

OdFdFieldEnginePE

)

parseObjProp()

virtual bool OdFdFieldEnginePE::parseObjProp ( const OdString &  prop, OdDbDatabase *  pDb, OdDbObjectId &  objId, OdString &  propName  )

pure virtual

Parses the property string of the ObjProp field code and retrieves object ID and property type.

Parameters

prop	[in] Property string of the format: "Object(%<\_ObjId XXX>%).PropName".
pDb	[in] Database.
objId	[out] Object ID.
propName	[out] Property name.

Returns

True if the operation is successful, false otherwise.

---

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

• FdField.h