CFx SDK Documentation  2023 SP0
Public Member Functions | Protected Attributes | Friends | List of all members
AECDbObject Class Reference

#include <AECDbObject.h>

Inheritance diagram for AECDbObject:
OdDbObject OdGiDrawable OdRxObject AECDbAnchor AECDbBlockRefPath AECDbDictRecord AECDbObjectGeometryVersionContainer AECDbPropSetOverrideContainer AECDbRefDoc AECDbTextNote AECDbAnchorToRef AECDb2dSectionStyle AECDbBlockRefPathDictRec AECDbClassificationDef AECDbClassificationSystemDef AECDbCleanupGroupDef AECDbDcContent AECDbDimensionGroupOverride AECDbDimensionStyle AECDbDispProps AECDbDispRep AECDbDispRepConfig AECDbDispRepSet AECDbDisplayThemeStyle AECDbDoorStyle AECDbEndcapStyle AECDbGridAssemblyStyle AECDbLayerKeyStyle AECDbListItem AECDbMaskBlockDef AECDbMassElemStyle AECDbMaterialDef AECDbMvBlockDef AECDbOpeningEndcapStyle AECDbPolygonStyle AECDbProfileDef AECDbPropertySet AECDbPropertySetDef AECDbRailingStyle AECDbScheduleDataFormat AECDbScheduleTableStyle AECDbSlabEdgeStyle AECDbSlabStyle AECDbSpaceModifier AECDbSpaceStyle AECDbStairStyle AECDbStairWinderStyle AECDbStairWinderType AECDbStdSizeOpeningList AECDbVars AECDbWallModStyle AECDbWallStyle AECDbWindowStyle AECDbZoneDef AECDbZoneStyle AECSDbMemberNodeShape AECSDbMemberStyle

Public Member Functions

virtual void subClose ()
 
virtual OdResult dwgInFields (OdDbDwgFiler *pFiler)
 
virtual void dwgOutFields (OdDbDwgFiler *pFiler) const
 
virtual void dxfOut (OdDbDxfFiler *pFiler) const
 
virtual void audit (OdDbAuditInfo *pAuditInfo)
 
const OdStringGetDescription () const
 
void SetDescription (const OdString &strDescription)
 
OdUInt32 GetOverrideCount () const
 
AECOverrideSubPtr GetOverrideByIndex (OdUInt32 iIndex) const
 
AECImpArraySubPtr GetOverrides ()
 
OdDbObjectId GetCurrentDispProps (const OdDbObjectId &idDispRep)
 
OdDbObjectId OverrideDispProps (const OdDbObjectId &idDispRep, bool bCopyContents=true)
 
void RemoveDispProps (const OdDbObjectId &idDispRep)
 
- Public Member Functions inherited from OdDbObject
 ODDB_DECLARE_MEMBERS (OdDbObject)
 
 ~OdDbObject ()
 
void addRef ()
 
void release ()
 
long numRefs () const
 
OdDbObjectId objectId () const
 
OdDbHandle getDbHandle () const
 
OdDbHandle handle () const
 
OdDbObjectId ownerId () const
 
virtual void setOwnerId (OdDbObjectId ownerId)
 
OdDbDatabasedatabase () const
 
void createExtensionDictionary ()
 
OdDbObjectId extensionDictionary () const
 
bool releaseExtensionDictionary ()
 
OdDbXrecordPtr createXrecord (const OdString &xrecordName, OdDb::DuplicateRecordCloning style=OdDb::kDrcIgnore)
 
void upgradeOpen ()
 
void downgradeOpen ()
 
void cancel ()
 
virtual OdResult subOpen (OdDb::OpenMode mode)
 
OdResult erase (bool eraseIt=true)
 
virtual OdResult subErase (bool erasing)
 
void handOverTo (OdDbObject *pNewObject, bool keepXData=true, bool keepExtDict=true)
 
virtual void subHandOverTo (OdDbObject *pNewObject)
 
void swapIdWith (OdDbObjectId otherId, bool swapXdata=false, bool swapExtDict=false)
 
virtual void subSwapIdWith (const OdDbObjectId &otherId, bool swapXdata=false, bool swapExtDict=false)
 
void dwgIn (OdDbDwgFiler *pFiler)
 
void dwgOut (OdDbDwgFiler *pFiler) const
 
virtual OdResult dxfIn (OdDbDxfFiler *pFiler)
 
virtual OdResult dxfInFields (OdDbDxfFiler *pFiler)
 
virtual void dxfOutFields (OdDbDxfFiler *pFiler) const
 
virtual OdResult dxfInFields_R12 (OdDbDxfFiler *pFiler)
 
virtual void dxfOutFields_R12 (OdDbDxfFiler *pFiler) const
 
virtual OdDb::DuplicateRecordCloning mergeStyle () const
 
virtual OdResBufPtr xData (const OdString &regappName=OdString::kEmpty) const
 
virtual void setXData (const OdResBuf *pRb)
 
bool isEraseStatusToggled () const
 
bool isErased () const
 
bool isReadEnabled () const
 
bool isWriteEnabled () const
 
bool isNotifyEnabled () const
 
bool isModified () const
 
bool isModifiedXData () const
 
bool isModifiedGraphics () const
 
bool isNewObject () const
 
bool isNotifying () const
 
bool isUndoing () const
 
bool isReallyClosing () const
 
bool isDBRO () const
 
void assertReadEnabled () const
 
void assertWriteEnabled (bool autoUndo=true, bool recordModified=true)
 
void assertNotifyEnabled () const
 
void disableUndoRecording (bool disable)
 
bool isUndoRecordingDisabled () const
 
OdDbDwgFilerundoFiler ()
 
virtual void applyPartialUndo (OdDbDwgFiler *pUndoFiler, OdRxClass *pClassObj)
 
void addReactor (OdDbObjectReactor *pReactor) const
 
void removeReactor (OdDbObjectReactor *pReactor) const
 
virtual void addPersistentReactor (const OdDbObjectId &objId)
 
virtual void removePersistentReactor (const OdDbObjectId &objId)
 
bool hasPersistentReactor (const OdDbObjectId &objId) const
 
OdDbObjectIdArray getPersistentReactors () const
 
OdDbObjectReactorArray getTransientReactors () const
 
virtual void recvPropagateModify (const OdDbObject *pSubObj)
 
virtual void xmitPropagateModify () const
 
ODRX_SEALED_VIRTUAL OdDbObjectPtr deepClone (OdDbIdMapping &ownerIdMap, OdDbObject *pOwner, bool bPrimary=true) const ODRX_SEALED
 
ODRX_SEALED_VIRTUAL OdDbObjectPtr wblockClone (OdDbIdMapping &ownerIdMap, OdDbObject *pOwner, bool bPrimary=true) const ODRX_SEALED
 
virtual void appendToOwner (OdDbIdPair &idPair, OdDbObject *pOwnerObject, OdDbIdMapping &ownerIdMap)
 
void setOdDbObjectIdsInFlux ()
 
bool isOdDbObjectIdsInFlux () const
 
virtual void copied (const OdDbObject *pObject, const OdDbObject *pNewObject)
 
virtual void erased (const OdDbObject *pObject, bool erasing=true)
 
virtual void goodbye (const OdDbObject *pObject)
 
virtual void openedForModify (const OdDbObject *pObject)
 
virtual void modified (const OdDbObject *pObject)
 
virtual void subObjModified (const OdDbObject *pObject, const OdDbObject *pSubObj)
 
virtual void modifyUndone (const OdDbObject *pObject)
 
virtual void modifiedXData (const OdDbObject *pObject)
 
virtual void unappended (const OdDbObject *pObject)
 
virtual void reappended (const OdDbObject *pObject)
 
bool isAProxy () const
 
virtual void objectClosed (const OdDbObjectId &objectId)
 
virtual void modifiedGraphics (const OdDbObject *pObject)
 
virtual void copyFrom (const OdRxObject *pSource)
 
bool hasSaveVersionOverride () const
 
void setHasSaveVersionOverride (bool hasSaveVersionOverride)
 
virtual OdDb::DwgVersion getObjectSaveVersion (const OdDbFiler *pFiler, OdDb::MaintReleaseVer *pMaintVer=0) const
 
virtual OdDbObjectPtr decomposeForSave (OdDb::DwgVersion ver, OdDbObjectId &replaceId, bool &exchangeXData)
 
virtual OdDbObjectPtr decomposeForSave (OdDb::SaveType format, OdDb::DwgVersion ver, OdDbObjectId &replaceId, bool &exchangeXData)
 
void convertForSave (OdDb::DwgVersion ver)
 
virtual void composeForLoad (OdDb::SaveType format, OdDb::DwgVersion version, OdDbAuditInfo *pAuditInfo)
 
virtual OdGiDrawabledrawable ()
 
virtual OdUInt32 subSetAttributes (OdGiDrawableTraits *pTraits) const
 
virtual bool subWorldDraw (OdGiWorldDraw *pWd) const
 
virtual void subViewportDraw (OdGiViewportDraw *pVd) const
 
virtual bool isPersistent () const
 
virtual OdDbStub * id () const
 
ODRX_SEALED_VIRTUAL OdResult getClassID (void *pClsid) const ODRX_SEALED
 
void setGsNode (OdGsCache *pNode)
 
OdGsCachegsNode () const
 
void xDataTransformBy (const OdGeMatrix3d &xfm)
 
bool hasFields () const
 
OdDbObjectId getField (const OdString &fieldName) const
 
OdDbObjectPtr getField (const OdString &fieldName, OdDb::OpenMode mode) const
 
virtual OdDbObjectId setField (const OdString &fieldName, OdDbField *pField)
 
virtual OdResult removeField (OdDbObjectId fieldId)
 
virtual OdDbObjectId removeField (const OdString &fieldName)
 
OdDbObjectId getFieldDictionary () const
 
OdDbObjectPtr getFieldDictionary (OdDb::OpenMode mode) const
 
virtual OdRxClasssaveAsClass (OdRxClass *pClass) const
 
- Public Member Functions inherited from OdGiDrawable
 ODRX_DECLARE_MEMBERS (OdGiDrawable)
 
virtual DrawableType drawableType () const
 
ODRX_SEALED_VIRTUAL OdUInt32 setAttributes (OdGiDrawableTraits *pTraits) const ODRX_SEALED
 
ODRX_SEALED_VIRTUAL bool worldDraw (OdGiWorldDraw *pWd) const ODRX_SEALED
 
ODRX_SEALED_VIRTUAL void viewportDraw (OdGiViewportDraw *pVd) const ODRX_SEALED
 
ODRX_SEALED_VIRTUAL OdUInt32 viewportDrawLogicalFlags (OdGiViewportDraw *pVd) const ODRX_SEALED
 
virtual OdResult getGeomExtents (OdGeExtents3d &extents) const
 
ODRX_SEALED_VIRTUAL OdUInt32 regenSupportFlags () const ODRX_SEALED
 
- 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
 
bool isKindOf (const OdRxClass *pClass) const
 
virtual OdRxObjectPtr clone () const
 
virtual OdRx::Ordering comparedTo (const OdRxObject *pOther) const
 
virtual bool isEqualTo (const OdRxObject *pOther) const
 

Protected Attributes

AECImpObjPtr m_pImpObject
 
AECImpArrayPtr m_pOverrides
 
- Protected Attributes inherited from OdDbObject
OdDbObjectImplm_pImpl
 

Friends

class AECInternalTools
 

Additional Inherited Members

- Public Types inherited from OdGiDrawable
enum  SetAttributesFlags {
  kDrawableNone = 0 , kDrawableIsAnEntity = 1 , kDrawableUsesNesting = 2 , kDrawableIsCompoundObject = 4 ,
  kDrawableViewIndependentViewportDraw = 8 , kDrawableIsInvisible = 16 , kDrawableHasAttributes = 32 , kDrawableRegenTypeDependantGeometry = 64 ,
  kDrawableIsDimension = (kDrawableIsAnEntity + kDrawableIsCompoundObject + 128) , kDrawableRegenDraw = 256 , kDrawableStandardDisplaySingleLOD = 512 , kDrawableShadedDisplaySingleLOD = 1024 ,
  kDrawableViewDependentViewportDraw = 2048 , kDrawableBlockDependentViewportDraw = 4096 , kDrawableIsExternalReference = 8192 , kDrawableNotPlottable = 16384 ,
  kLastFlag = kDrawableNotPlottable
}
 
enum  DrawableType {
  kGeometry = 0 , kDistantLight = 1 , kPointLight = 2 , kSpotLight = 3 ,
  kAmbientLight , kSolidBackground , kGradientBackground , kImageBackground ,
  kGroundPlaneBackground , kViewport , kWebLight , kSkyBackground ,
  kImageBasedLightingBackground
}
 
- Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr cast (const OdRxObject *pointer)
 
static OdRxClassdesc ()
 
- Protected Member Functions inherited from OdDbObject
 OdDbObject ()
 
virtual OdResult subGetClassID (void *pClsid) const
 
virtual OdDbObjectPtr subDeepClone (OdDbIdMapping &ownerIdMap, OdDbObject *pOwner, bool bPrimary) const
 
virtual OdDbObjectPtr subWblockClone (OdDbIdMapping &ownerIdMap, OdDbObject *pOwner, bool bPrimary) const
 
- Protected Member Functions inherited from OdGiDrawable
 OdGiDrawable ()
 
virtual OdUInt32 subViewportDrawLogicalFlags (OdGiViewportDraw *vd) const
 
virtual OdUInt32 subRegenSupportFlags () const
 

Detailed Description

Abstract base class for AEC database objects.

Remarks
Contains the description and the array of overrides.

<group TA_API_Objects>

Definition at line 40 of file AECDbObject.h.

Member Function Documentation

◆ audit()

virtual void AECDbObject::audit ( OdDbAuditInfo pAuditInfo)
virtual

Perform an audit operation on this object.

Parameters
pAuditInfo[in] Pointer to an OdDbAuditInfo object.
Remarks
The specified OdDbAuditInfo object controls the audit, and receives the audit status.

When overriding this function for a custom class, first call OdDbObject::audit(pAuditInfo) to validate the audit operation.

Reimplemented from OdDbObject.

Reimplemented in AECDbDispPropsSlab, and AECDbDispPropsMassElem.

◆ dwgInFields()

virtual OdResult AECDbObject::dwgInFields ( OdDbDwgFiler pFiler)
virtual

OdDbObject override.

Reimplemented from OdDbObject.

◆ dwgOutFields()

virtual void AECDbObject::dwgOutFields ( OdDbDwgFiler pFiler) const
virtual

OdDbObject override.

Reimplemented from OdDbObject.

◆ dxfOut()

virtual void AECDbObject::dxfOut ( OdDbDxfFiler pFiler) const
virtual

OdDbObject override.

Reimplemented from OdDbObject.

◆ GetCurrentDispProps()

OdDbObjectId AECDbObject::GetCurrentDispProps ( const OdDbObjectId idDispRep)

Returns Display Properties currently used for Display Representation of specified type.

◆ GetDescription()

const OdString& AECDbObject::GetDescription ( ) const

Returns the description.

◆ GetOverrideByIndex()

AECOverrideSubPtr AECDbObject::GetOverrideByIndex ( OdUInt32  iIndex) const

Returns Override by index.

Remarks
Throws eInvalidIndex exception in case of invalid index.

◆ GetOverrideCount()

OdUInt32 AECDbObject::GetOverrideCount ( ) const

Returns the number of Overrides.

◆ GetOverrides()

AECImpArraySubPtr AECDbObject::GetOverrides ( )

Returns the array of Overrides.

◆ OverrideDispProps()

OdDbObjectId AECDbObject::OverrideDispProps ( const OdDbObjectId idDispRep,
bool  bCopyContents = true 
)

Overrides Display Properties for specified Display Representation.

Returns
Object ID of new Display Properties object (in override).
Remarks
If such override already exist then it is not replaced with new one. Return value in this case is Object ID of Display Properties referenced by old override.

◆ RemoveDispProps()

void AECDbObject::RemoveDispProps ( const OdDbObjectId idDispRep)

Removes Display Properties override for specified Display Representation.

Remarks
If there is no such override this method does nothing.

◆ SetDescription()

void AECDbObject::SetDescription ( const OdString strDescription)

Sets description.

◆ subClose()

virtual void AECDbObject::subClose ( )
virtual

OdDbObject override.

Reimplemented from OdDbObject.

Reimplemented in AECDbDispRep, AECDbDispProps, and AECDbStairWinderStyle.

Friends And Related Function Documentation

◆ AECInternalTools

friend class AECInternalTools
friend

Definition at line 136 of file AECDbObject.h.

Member Data Documentation

◆ m_pImpObject

AECImpObjPtr AECDbObject::m_pImpObject
protected

Definition at line 128 of file AECDbObject.h.

◆ m_pOverrides

AECImpArrayPtr AECDbObject::m_pOverrides
protected

Definition at line 134 of file AECDbObject.h.


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