CFx SDK Documentation  2020SP3
DbCompoundObjectId.h
Go to the documentation of this file.
1 // Copyright (C) 2002-2017, Open Design Alliance (the "Alliance").
3 // All rights reserved.
4 //
5 // This software and its documentation and related materials are owned by
6 // the Alliance. The software may only be incorporated into application
7 // programs owned by members of the Alliance, subject to a signed
8 // Membership Agreement and Supplemental Software License Agreement with the
9 // Alliance. The structure and organization of this software are the valuable
10 // trade secrets of the Alliance and its suppliers. The software is also
11 // protected by copyright law and international treaty provisions. Application
12 // programs incorporating this software must include the following statement
13 // with their copyright notices:
14 //
15 // This application incorporates Teigha(R) software pursuant to a license
16 // agreement with Open Design Alliance.
17 // Teigha(R) Copyright (C) 2002-2017 by Open Design Alliance.
18 // All rights reserved.
19 //
20 // By use of this software, its documentation or related materials, you
21 // acknowledge and accept the above terms.
23 
24 #ifndef OdDbCompoundObjectId_INCLUDED
25 #define OdDbCompoundObjectId_INCLUDED
26 
27 #include "RxObject.h"
28 #include "DbObjectId.h"
29 #include "IdArrays.h"
30 
31 class OdDbDwgFiler;
32 class OdDbDxfFiler;
33 
34 class OdGeMatrix3d;
35 class OdDbIdMapping;
36 class OdDbCompoundObjectIdImpl;
37 
38 #include "TD_PackPush.h"
39 
45 {
46 public:
48 
50 
51  OdDbCompoundObjectId& operator =(const OdDbObjectId&);
53 
54  bool operator ==(const OdDbCompoundObjectId&) const;
55  bool operator !=(const OdDbCompoundObjectId& other) const;
56 
58 
60 
62 
64 
65  void setEmpty();
66 
67  OdResult set(const OdDbObjectId&, OdDbDatabase* pHostDatabase = NULL);
68 
69  OdResult set(const OdDbCompoundObjectId&, OdDbDatabase* pHostDatabase = NULL);
70 
71  OdResult set(const OdDbObjectId& id, const OdDbObjectIdArray& path, OdDbDatabase* pHostDatabase = NULL);
72 
73  OdResult setFullPath(const OdDbObjectIdArray& fullPath, OdDbDatabase* pHostDatabase = NULL);
74 
75  bool isEmpty() const;
76 
77  bool isValid(int validityCheckingLevel = 1) const;
78 
79  bool isExternal() const;
80 
81  bool isSimpleObjectId() const;
82 
84 
85  bool remap(const OdDbIdMapping& idMap);
86 
87  OdResult dwgOutFields(OdDbDwgFiler* pFiler, OdDbDatabase* pHostDatabase) const;
88 
89  OdResult dwgInFields(OdDbDwgFiler* pFiler, int ownerVersion);
90 
91  OdResult dxfOutFields(OdDbDxfFiler* pFiler, OdDbDatabase* pHostDatabase) const;
92 
93  OdResult dxfInFields(OdDbDxfFiler* pFiler, OdDbDatabase* pHostDatabase, int ownerVersion);
94 
95  static const OdDbCompoundObjectId& nullId();
96 
97 protected:
99  OdDbCompoundObjectId(OdDbCompoundObjectIdImpl*);
100 
101  OdDbCompoundObjectIdImpl* m_pImpl;
102 };
103 
105 
106 #include "TD_PackPop.h"
107 
108 #endif
OdDbCompoundObjectId::setFullPath
OdResult setFullPath(const OdDbObjectIdArray &fullPath, OdDbDatabase *pHostDatabase=NULL)
OdDbCompoundObjectId::setEmpty
void setEmpty()
OdResult
OdResult
Definition: OdResult.h:29
OdDbCompoundObjectId::isEmpty
bool isEmpty() const
OdDbDatabase
Definition: DbDatabase.h:421
NULL
#define NULL
Definition: GsProperties.h:177
OdDbCompoundObjectId::nullId
static const OdDbCompoundObjectId & nullId()
OdDbCompoundObjectId
Definition: DbCompoundObjectId.h:45
IdArrays.h
OdDbCompoundObjectId::OdDbCompoundObjectId
OdDbCompoundObjectId()
OdDbCompoundObjectIdPtr
OdSmartPtr< OdDbCompoundObjectId > OdDbCompoundObjectIdPtr
Definition: DbCompoundObjectId.h:104
OdDbCompoundObjectId::topId
OdDbObjectId topId() const
OdRxObject
Definition: RxObject.h:564
OdDbObjectId
Definition: DbObjectId.h:99
OdDbCompoundObjectId::getTransform
OdResult getTransform(OdGeMatrix3d &trans) const
OdArray< OdDbObjectId, OdMemoryAllocator< OdDbObjectId > >
OdDbCompoundObjectId::getPath
OdResult getPath(OdDbObjectIdArray &path) const
TD_PackPop.h
OdDbCompoundObjectId::isValid
bool isValid(int validityCheckingLevel=1) const
RxObject.h
OdGeMatrix3d
Definition: GeMatrix3d.h:73
OdDbCompoundObjectId::dxfInFields
OdResult dxfInFields(OdDbDxfFiler *pFiler, OdDbDatabase *pHostDatabase, int ownerVersion)
OdDbCompoundObjectId::getFullPath
OdResult getFullPath(OdDbObjectIdArray &fullPath) const
OdDbCompoundObjectId::isExternal
bool isExternal() const
OdDbCompoundObjectId::dwgInFields
OdResult dwgInFields(OdDbDwgFiler *pFiler, int ownerVersion)
OdSmartPtr
Definition: SmartPtr.h:58
OdDAI::operator!=
bool DAI_EXPORT operator!=(const OdDAI::OdSelect &left, const OdDAI::OdSelect &right)
OdDbCompoundObjectId::isSimpleObjectId
bool isSimpleObjectId() const
DbObjectId.h
OdDbCompoundObjectId::~OdDbCompoundObjectId
virtual ~OdDbCompoundObjectId()
OdDbCompoundObjectId::ODRX_DECLARE_MEMBERS
ODRX_DECLARE_MEMBERS(OdDbCompoundObjectId)
OdDbCompoundObjectId::set
OdResult set(const OdDbObjectId &, OdDbDatabase *pHostDatabase=NULL)
OdDbDxfFiler
Definition: DbFiler.h:194
OdDbCompoundObjectId::OdDbCompoundObjectId
OdDbCompoundObjectId(OdDbCompoundObjectIdImpl *)
OdDbCompoundObjectId::set
OdResult set(const OdDbCompoundObjectId &, OdDbDatabase *pHostDatabase=NULL)
TD_PackPush.h
OdDbCompoundObjectId::dwgOutFields
OdResult dwgOutFields(OdDbDwgFiler *pFiler, OdDbDatabase *pHostDatabase) const
OdDbCompoundObjectId::m_pImpl
OdDbCompoundObjectIdImpl * m_pImpl
Definition: DbCompoundObjectId.h:101
OdDAI::operator==
bool DAI_EXPORT operator==(const OdFileDescriptionAuto &left, const OdFileDescriptionAuto &right)
OdDbCompoundObjectId::remap
bool remap(const OdDbIdMapping &idMap)
TOOLKIT_EXPORT
#define TOOLKIT_EXPORT
Definition: DbExport.h:40
OdDbCompoundObjectId::dxfOutFields
OdResult dxfOutFields(OdDbDxfFiler *pFiler, OdDbDatabase *pHostDatabase) const
OdDbCompoundObjectId::set
OdResult set(const OdDbObjectId &id, const OdDbObjectIdArray &path, OdDbDatabase *pHostDatabase=NULL)
OdDbIdMapping
Definition: DbIdMapping.h:238
OdDbCompoundObjectId::leafId
OdDbObjectId leafId() const
OdDbDwgFiler
Definition: DbFiler.h:1031