CFx SDK Documentation 2024 SP0
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
CFxBIMStorage Class Reference

#include <FxBIMStorage.h>

Inheritance diagram for CFxBIMStorage:
OdDbObject OdGiDrawable OdRxObject

Public Types

enum  { eModifyUnlocked = 0x1 , eMainDatabase = 0x2 , eFlatshotDatabase = 0x4 }
 
using drawings_map = std::map< OdDbHandle, std::vector< CFxBIMDrawingPtr > >
 
- 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 ,
  kDrawableNotAllowLCS = 32768 , kDrawableMergeControlOff = 65536 , kLastFlag = kDrawableMergeControlOff
}
 
enum  DrawableType {
  kGeometry = 0 , kDistantLight = 1 , kPointLight = 2 , kSpotLight = 3 ,
  kAmbientLight , kSolidBackground , kGradientBackground , kImageBackground ,
  kGroundPlaneBackground , kViewport , kWebLight , kSkyBackground ,
  kImageBasedLightingBackground
}
 

Public Member Functions

 ODDB_DECLARE_MEMBERS (CFxBIMStorage)
 
virtual ~CFxBIMStorage ()
 
virtual Error AddDatabaseRef (CFxBIMDatabaseReferencePtr pBimDbRef)
 
virtual Error RemoveDatabaseRef (CFxBIMDatabaseReferencePtr pBimDbRef)
 
virtual CFxBIMDbIteratorRAPtr DatabaseRefs () const
 
virtual CFxBIMDatabaseReferencePtr DatabaseRef (CFxBIMDatabasePtr pBimDb) const
 
virtual Error AddSection (OdDbObjectId idSection)
 
virtual Error RemoveSection (OdDbObjectId idSection)
 
virtual OdDbObjectId FindSection (const OdString &name) const
 
virtual CFxBIMDbIteratorRAPtr Sections () const
 
virtual CFxBIMIteratorPtr Disciplines (OdDb::OpenMode openMode) const
 
virtual CFxBIMIteratorPtr Zones (OdDb::OpenMode openMode) const
 
virtual CFxBIMIteratorPtr Spaces (OdDb::OpenMode openMode) const
 
virtual CFxBIMIteratorPtr Floors (OdDb::OpenMode openMode) const
 
virtual CFxBIMIteratorPtr Categories (OdDb::OpenMode openMode) const
 
virtual CFxBIMIteratorPtr Types (OdDb::OpenMode openMode) const
 
virtual CFxBIMDbIteratorPtr Entities (OdDb::OpenMode openMode) const
 
virtual CFxBIMDbIteratorPtr EntityRefs (OdDb::OpenMode openMode) const
 
virtual Error AddReactor (CFxBIMObjectPtr p) const
 
virtual Error RemoveReactor (CFxBIMObjectPtr p) const
 
virtual CFxBIMDbIteratorPtr Materials (OdDb::OpenMode openMode) const
 
virtual const std::vector< CFxBIMDrawingPtr > & BimDrawings (CFxBIMSectionPtr pS) const
 
virtual std::vector< CFxBIMDrawingPtr > & BimDrawings (CFxBIMSectionPtr pS)
 
virtual const drawings_mapBimDrawings () const
 
virtual drawings_mapBimDrawings ()
 
virtual int Flags () const
 
virtual void SetFlags (int flags)
 
OdResult dwgInFields (OdDbDwgFiler *pFiler) override
 
void dwgOutFields (OdDbDwgFiler *pFiler) const override
 
OdResult dxfInFields (OdDbDxfFiler *pFiler) override
 
void dxfOutFields (OdDbDxfFiler *pFiler) const override
 
void subClose () override
 
void audit (OdDbAuditInfo *pAuditInfo) override
 
- 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)
 
virtual void subClose ()
 
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)
 
virtual void audit (OdDbAuditInfo *pAuditInfo)
 
void dwgIn (OdDbDwgFiler *pFiler)
 
void dwgOut (OdDbDwgFiler *pFiler) const
 
virtual OdResult dxfIn (OdDbDxfFiler *pFiler)
 
virtual void dxfOut (OdDbDxfFiler *pFiler) const
 
virtual OdResult dwgInFields (OdDbDwgFiler *pFiler)
 
virtual void dwgOutFields (OdDbDwgFiler *pFiler) const
 
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 &idMap, OdDbObject *pOwner, bool bPrimary=true) const ODRX_SEALED
 
ODRX_SEALED_VIRTUAL OdDbObjectPtr wblockClone (OdDbIdMapping &idMap, OdDbObject *pOwner, bool bPrimary=true) const ODRX_SEALED
 
virtual void appendToOwner (OdDbIdPair &idPair, OdDbObject *pOwnerObject, OdDbIdMapping &idMap)
 
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
 
virtual bool isPersistent () const =0
 
virtual OdDbStub * id () const =0
 
virtual void setGsNode (OdGsCache *pGsNode)=0
 
virtual OdGsCachegsNode () const =0
 
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
 
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
 

Static Public Member Functions

static CFxBIMStoragePtr GetStorage (OdDbDatabase *pDatabase, OdDb::OpenMode eMode=OdDb::kForRead, bool bCreateIfNotExist=false)
 
- Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr cast (const OdRxObject *pointer)
 
static OdRxClassdesc ()
 

Protected Member Functions

 CFxBIMStorage ()
 
- 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 subSetAttributes (OdGiDrawableTraits *traits) const =0
 
virtual bool subWorldDraw (OdGiWorldDraw *wd) const =0
 
virtual void subViewportDraw (OdGiViewportDraw *vd) const =0
 
virtual OdUInt32 subViewportDrawLogicalFlags (OdGiViewportDraw *vd) const
 
virtual OdUInt32 subRegenSupportFlags () const
 

Additional Inherited Members

- Protected Attributes inherited from OdDbObject
OdDbObjectImplm_pImpl
 

Detailed Description

Definition at line 41 of file FxBIMStorage.h.

Member Typedef Documentation

◆ drawings_map

using CFxBIMStorage::drawings_map = std::map< OdDbHandle, std::vector< CFxBIMDrawingPtr > >

Definition at line 81 of file FxBIMStorage.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
eModifyUnlocked 
eMainDatabase 
eFlatshotDatabase 

Definition at line 85 of file FxBIMStorage.h.

Constructor & Destructor Documentation

◆ ~CFxBIMStorage()

virtual CFxBIMStorage::~CFxBIMStorage ( )
virtual

◆ CFxBIMStorage()

CFxBIMStorage::CFxBIMStorage ( )
protected

Member Function Documentation

◆ AddDatabaseRef()

virtual Error CFxBIMStorage::AddDatabaseRef ( CFxBIMDatabaseReferencePtr  pBimDbRef)
virtual

◆ AddReactor()

virtual Error CFxBIMStorage::AddReactor ( CFxBIMObjectPtr  p) const
virtual

◆ AddSection()

virtual Error CFxBIMStorage::AddSection ( OdDbObjectId  idSection)
virtual

◆ audit()

void CFxBIMStorage::audit ( OdDbAuditInfo pAuditInfo)
overridevirtual

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.

◆ BimDrawings() [1/4]

virtual drawings_map & CFxBIMStorage::BimDrawings ( )
virtual

◆ BimDrawings() [2/4]

virtual const drawings_map & CFxBIMStorage::BimDrawings ( ) const
virtual

◆ BimDrawings() [3/4]

virtual std::vector< CFxBIMDrawingPtr > & CFxBIMStorage::BimDrawings ( CFxBIMSectionPtr  pS)
virtual

◆ BimDrawings() [4/4]

virtual const std::vector< CFxBIMDrawingPtr > & CFxBIMStorage::BimDrawings ( CFxBIMSectionPtr  pS) const
virtual

◆ Categories()

virtual CFxBIMIteratorPtr CFxBIMStorage::Categories ( OdDb::OpenMode  openMode) const
virtual

◆ DatabaseRef()

virtual CFxBIMDatabaseReferencePtr CFxBIMStorage::DatabaseRef ( CFxBIMDatabasePtr  pBimDb) const
virtual

◆ DatabaseRefs()

virtual CFxBIMDbIteratorRAPtr CFxBIMStorage::DatabaseRefs ( ) const
virtual

◆ Disciplines()

virtual CFxBIMIteratorPtr CFxBIMStorage::Disciplines ( OdDb::OpenMode  openMode) const
virtual

◆ dwgInFields()

OdResult CFxBIMStorage::dwgInFields ( OdDbDwgFiler pFiler)
overridevirtual

Reads the .dwg file data of this object.

Parameters
pFiler[in] Filer object from which data are read.
Returns
Returns the filer status.

This function is called by dwgIn() to allow the object to read its data.

When overriding this function:

1) Call assertWriteEnabled(). 2) Call the parent class's dwgInFields(pFiler). 3) If it returns eOK, continue; otherwise return whatever the parent's dwgInFields(pFiler) returned. 4) Call the OdDbDwgFiler(pFiler) methods to read each of the object's data items in the order they were written. 5) Return pFiler->filerStatus().

Reimplemented from OdDbObject.

◆ dwgOutFields()

void CFxBIMStorage::dwgOutFields ( OdDbDwgFiler pFiler) const
overridevirtual

Writes the .dwg file data of this object.

Parameters
pFiler[in] Pointer to the filer to which data are written.
Remarks

This function is called by dwgIn() to allow the object to write its data.

When overriding this function:

1) Call assertReadEnabled(). 2) Call the parent class's dwgOutFields(pFiler). 3) Call the OdDbDwgFiler(pFiler) methods to write each of the object's data items in the order they were written.

Reimplemented from OdDbObject.

◆ dxfInFields()

OdResult CFxBIMStorage::dxfInFields ( OdDbDxfFiler pFiler)
overridevirtual

Reads the DXF data of this object.

Parameters
pFiler[in] Pointer to the filer from which data are read.
Returns
Returns the filer status.

This function is called by dxfIn() to allow the object to read its data.

When overriding this function:

1) Call assertWriteEnabled(). 2) Call the parent class's dwgInFields(pFiler). 3) If it returns eOK, continue; otherwise return whatever the parent's dxfInFields(pFiler) returned. 4) Call the OdDbDxfFiler(pFiler) methods to read each of the object's data items in the order they were written. 5) Return pFiler->filerStatus().

Reimplemented from OdDbObject.

◆ dxfOutFields()

void CFxBIMStorage::dxfOutFields ( OdDbDxfFiler pFiler) const
overridevirtual

Writes the DXF data of this object.

Parameters
pFiler[in] Pointer to the filer to which data are to be written.
Remarks

This function is called by dxfOut() to allow the object to write its data.

When overriding this function:

1) Call assertReadEnabled(). 2) Call the parent class's dxfOutFields(pFiler). 4) Use pFiler to call the OdDbDxfFiler methods to write each of the object's data items in the order they were written.

Reimplemented from OdDbObject.

◆ Entities()

virtual CFxBIMDbIteratorPtr CFxBIMStorage::Entities ( OdDb::OpenMode  openMode) const
virtual

◆ EntityRefs()

virtual CFxBIMDbIteratorPtr CFxBIMStorage::EntityRefs ( OdDb::OpenMode  openMode) const
virtual

◆ FindSection()

virtual OdDbObjectId CFxBIMStorage::FindSection ( const OdString name) const
virtual

◆ Flags()

virtual int CFxBIMStorage::Flags ( ) const
virtual

◆ Floors()

virtual CFxBIMIteratorPtr CFxBIMStorage::Floors ( OdDb::OpenMode  openMode) const
virtual

◆ GetStorage()

static CFxBIMStoragePtr CFxBIMStorage::GetStorage ( OdDbDatabase pDatabase,
OdDb::OpenMode  eMode = OdDb::kForRead,
bool  bCreateIfNotExist = false 
)
static

◆ Materials()

virtual CFxBIMDbIteratorPtr CFxBIMStorage::Materials ( OdDb::OpenMode  openMode) const
virtual

◆ ODDB_DECLARE_MEMBERS()

CFxBIMStorage::ODDB_DECLARE_MEMBERS ( CFxBIMStorage  )

◆ RemoveDatabaseRef()

virtual Error CFxBIMStorage::RemoveDatabaseRef ( CFxBIMDatabaseReferencePtr  pBimDbRef)
virtual

◆ RemoveReactor()

virtual Error CFxBIMStorage::RemoveReactor ( CFxBIMObjectPtr  p) const
virtual

◆ RemoveSection()

virtual Error CFxBIMStorage::RemoveSection ( OdDbObjectId  idSection)
virtual

◆ Sections()

virtual CFxBIMDbIteratorRAPtr CFxBIMStorage::Sections ( ) const
virtual

◆ SetFlags()

virtual void CFxBIMStorage::SetFlags ( int  flags)
virtual

◆ Spaces()

virtual CFxBIMIteratorPtr CFxBIMStorage::Spaces ( OdDb::OpenMode  openMode) const
virtual

◆ subClose()

void CFxBIMStorage::subClose ( )
overridevirtual

Called as the first operation as this object is being closed, for database -resident objects only.

Remarks
This function is notified just before the current open operation is to be closed, giving this function the ability to perform necessary operatons.

When overriding this function:

1) If the OdDbObject's state is incorrect, throw exception.

2) Call parent class's subClose().

3) If other actions are required before close, do them.

The default implementation of this function does nothing. This function can be overridden in custom classes.

Reimplemented from OdDbObject.

◆ Types()

virtual CFxBIMIteratorPtr CFxBIMStorage::Types ( OdDb::OpenMode  openMode) const
virtual

◆ Zones()

virtual CFxBIMIteratorPtr CFxBIMStorage::Zones ( OdDb::OpenMode  openMode) const
virtual

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