CFx SDK Documentation  2020SP3
DbObjectContextCollection.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 _ODDB_OBJECTCONTEXTCOLLECTION_H_INCLUDED_
25 #define _ODDB_OBJECTCONTEXTCOLLECTION_H_INCLUDED_
26 
27 #include "DbObjectContext.h"
28 #include "TD_PackPush.h"
29 
32 
47 {
48 public:
50 
58  virtual OdString name() const = 0;
59 
70  const OdDbObject* pRequestingObject) const = 0;
71 
79  const OdDbObjectContext* pContext) = 0;
80 
92  const OdDbObjectContext* pContext) = 0;
93 
106  const OdString& contextName) = 0;
107 
112  const OdDbObjectContext* pContext) = 0;
113 
117  virtual OdResult unlockContext() = 0;
118 
122  virtual bool locked() const = 0;
123 
133  const OdString& contextName) const = 0;
134 
144  virtual bool hasContext(
145  const OdString& contextName) const = 0;
146 
151 };
152 
153 
155 // class OdDbObjectContextCollectionIterator
157 
172 {
173 public:
175 
182  virtual OdResult start() = 0;
183 
191  virtual bool next() = 0;
192 
200  virtual bool done() const = 0;
201 
206  virtual OdDbObjectContextPtr getContext() const = 0;
207 };
208 
209 #include "TD_PackPop.h"
210 
211 #endif // _ODDB_OBJECTCONTEXTCOLLECTION_H_INCLUDED_
OdResult
OdResult
Definition: OdResult.h:29
OdDbObjectContext
Definition: DbObjectContext.h:49
OdString
Definition: OdString.h:95
OdDbObjectContextCollection::setCurrentContext
virtual OdResult setCurrentContext(const OdDbObjectContext *pContext)=0
OdDbObjectContextCollection::lockContext
virtual OdResult lockContext(const OdDbObjectContext *pContext)=0
OdDbObjectContextCollection::hasContext
virtual bool hasContext(const OdString &contextName) const =0
OdDbObjectContextCollectionIterator::ODRX_DECLARE_MEMBERS
ODRX_DECLARE_MEMBERS(OdDbObjectContextCollectionIterator)
OdDbObjectContextCollection::newIterator
virtual OdDbObjectContextCollectionIteratorPtr newIterator() const =0
DbObjectContext.h
OdRxObject
Definition: RxObject.h:564
OdDbObjectContextCollection::locked
virtual bool locked() const =0
OdDbObjectContextCollectionIterator
Definition: DbObjectContextCollection.h:172
TD_PackPop.h
OdDbObjectContextCollection::name
virtual OdString name() const =0
OdDbObjectContextCollectionIterator::getContext
virtual OdDbObjectContextPtr getContext() const =0
OdDbObjectContextCollectionIterator::done
virtual bool done() const =0
OdSmartPtr
Definition: SmartPtr.h:58
OdDbObjectContextCollection::ODRX_DECLARE_MEMBERS
ODRX_DECLARE_MEMBERS(OdDbObjectContextCollection)
TD_PackPush.h
ODRX_ABSTRACT
#define ODRX_ABSTRACT
Definition: OdPlatformSettings.h:117
OdDbObjectContextCollection::addContext
virtual OdResult addContext(const OdDbObjectContext *pContext)=0
OdDbObjectContextCollection::currentContext
virtual OdDbObjectContextPtr currentContext(const OdDbObject *pRequestingObject) const =0
OdDbObjectContextCollectionIterator::next
virtual bool next()=0
OdDbObjectContextCollection::unlockContext
virtual OdResult unlockContext()=0
OdDbObjectContextCollectionIterator::start
virtual OdResult start()=0
TOOLKIT_EXPORT
#define TOOLKIT_EXPORT
Definition: DbExport.h:40
OdDbObjectContextCollection::removeContext
virtual OdResult removeContext(const OdString &contextName)=0
OdDbObjectContextCollection::getContext
virtual OdDbObjectContextPtr getContext(const OdString &contextName) const =0
OdDbObjectContextCollection
Definition: DbObjectContextCollection.h:47
OdDbObject
Definition: DbObject.h:211
OdDbObjectContextCollectionIteratorPtr
OdSmartPtr< OdDbObjectContextCollectionIterator > OdDbObjectContextCollectionIteratorPtr
Definition: DbObjectContextCollection.h:30