RxDictionary.h

Go to the documentation of this file.

// Copyright (C) 2002-2024, Open Design Alliance (the "Alliance"). 
// All rights reserved. 
// 
// This software and its documentation and related materials are owned by 
// the Alliance. The software may only be incorporated into application 
// programs owned by members of the Alliance, subject to a signed 
// Membership Agreement and Supplemental Software License Agreement with the
// Alliance. The structure and organization of this software are the valuable  
// trade secrets of the Alliance and its suppliers. The software is also 
// protected by copyright law and international treaty provisions. Application  
// programs incorporating this software must include the following statement 
// with their copyright notices:
//   
//   This application incorporates Open Design Alliance software pursuant to a license 
//   agreement with Open Design Alliance.
//   Open Design Alliance Copyright (C) 2002-2024 by Open Design Alliance. 
//   All rights reserved.
//
// By use of this software, its documentation or related materials, you 
// acknowledge and accept the above terms.
 
 
 
 
#ifndef _RXDICTIONARY_INC_
#define _RXDICTIONARY_INC_
 
 
#include "RxObject.h"
#include "RxIterator.h"
#include "RxDefs.h"
#include "RxNames.h"
 
class OdString;
 
#include "TD_PackPush.h"

class FIRSTDLL_EXPORT OdRxDictionaryIterator : public OdRxIterator
{
public:
  ODRX_DECLARE_MEMBERS(OdRxDictionaryIterator);

  virtual OdString getKey() const = 0;

  virtual OdUInt32 id() const = 0;
};

typedef OdSmartPtr<OdRxDictionaryIterator> OdRxDictionaryIteratorPtr;
 

class FIRSTDLL_EXPORT OdRxDictionary : public OdRxObject
{
public:
  ODRX_DECLARE_MEMBERS(OdRxDictionary);
  
  virtual void reserve(
    OdUInt32 minSize);

  virtual OdRxObjectPtr getAt(
    const OdString& key) const = 0;
    
  virtual OdRxObjectPtr getAt(
    OdUInt32 id) const = 0;

  virtual OdRxObjectPtr putAt(
    const OdString& key, 
    OdRxObject* pObject, 
    OdUInt32* pRetId = 0) = 0;
    
  virtual OdRxObjectPtr putAt(
    OdUInt32 id, 
    OdRxObject* pObject) = 0;
  
  virtual bool resetKey(
    OdUInt32 id, 
    const OdString& newKey) = 0;

  virtual OdRxObjectPtr remove(
    const OdString& key) = 0;
    
  virtual OdRxObjectPtr remove(
    OdUInt32 id) = 0;
 
  void removeAll() { OdUInt32 n = numEntries();  while(n--) remove(n); }

  virtual bool has(
    const OdString& key) const = 0;
    
  virtual bool has(
    OdUInt32 id) const = 0;
 

  virtual OdUInt32 idAt(
    const OdString& key) const = 0;

   virtual OdString keyAt(
    OdUInt32 id) const = 0;

  virtual OdUInt32 numEntries() const = 0;

  virtual OdRxDictionaryIteratorPtr newIterator(
    OdRx::DictIterType iterType = OdRx::kDictCollated) = 0;

  virtual bool isCaseSensitive() const = 0;
 
  inline OdSmartPtr<OdRxDictionary> subDict(const OdString* path, int numSteps);
};

typedef OdSmartPtr<OdRxDictionary> OdRxDictionaryPtr;
 

FIRSTDLL_EXPORT OdRxDictionary* odrxSysRegistry();
 

FIRSTDLL_EXPORT OdRxDictionaryPtr odrxClassDictionary();
 
inline OdRxClass* odrxGetClassDesc(const OdString& className) {
  return (OdRxClass*)(odrxClassDictionary()->getAt(className).get());
}
 
inline OdRxClass* odrxSafeGetClassDesc(const OdString& className) {
  OdRxClass* cls = (OdRxClass*)(odrxClassDictionary()->getAt(className).get());
  if (cls)
    return cls;
  throw OdError( className + OD_T( " class not registered" ) ); //FELIX_CHANGE
}
 
template <class TClass>
inline OdSmartPtr<TClass> odrxCastByClassName(const OdRxObject* obj, const OdString& className) {
  if(!obj || obj->isKindOf(odrxGetClassDesc(className)))
    return (TClass*)obj;
  return OdSmartPtr<TClass>();
}
 
template <class TClass>
inline OdSmartPtr<TClass> odrxSafeCastByClassName(const OdRxObject* obj, const OdString& className) {
  if(!obj || obj->isKindOf(odrxSafeGetClassDesc(className)))
    return (TClass*)obj;
  return OdSmartPtr<TClass>();
}

FIRSTDLL_EXPORT OdRxDictionaryPtr odrxServiceDictionary();
 

FIRSTDLL_EXPORT OdRxDictionaryPtr odrxCreateRxDictionary();
 

FIRSTDLL_EXPORT OdRxDictionaryPtr odrxCreateSyncRxDictionary();
 
 
inline OdRxDictionaryPtr OdRxDictionary::subDict(const OdString* path, int numSteps) {
  OdRxDictionaryPtr dir(this);
  for (int i = 0; !dir.isNull() && i < numSteps; ++i)
    dir = OdRxDictionary::cast(dir->getAt(path[i]));
  return dir;
}
 
#include "TD_PackPop.h"
 
#endif // _RXDICTIONARY_INC_