SlotManager.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.
 
 
// SlotManager.h: interface for the OdSlotManager class.
//
 
#ifndef _SLOTMANAGER_H_INCLUDED_
#define _SLOTMANAGER_H_INCLUDED_
 
#include "TD_PackPush.h"
 
#include "IntArray.h"
 
 
typedef unsigned int OdSlotId;
#define kOdNullSlotId OdSlotId(-1)
 

class OdSlotManager  
{
  OdIntArray  m_freeSlots;
  unsigned int  m_numSlots;
public:
  OdSlotManager() : m_numSlots(0) {}
  inline OdSlotId newSlot()
  {
    int res;
    if(m_freeSlots.isEmpty())
    {
      res = m_numSlots++;
    }
    else
    {
      res = m_freeSlots.last();
      m_freeSlots.removeLast();
    }
    return res;
  }

  inline void freeSlot(OdSlotId slotId)
  {
    if(slotId+1==m_numSlots)
    {
      --m_numSlots;
    }
    else
    {
      m_freeSlots.append(slotId);
    }
  }

  inline bool contains(OdSlotId slotId) const
  {
    return (slotId < m_numSlots && !m_freeSlots.contains(slotId, 0));
  }

  inline unsigned int numSlots() const
  {
    return m_numSlots;
  }
};

template <class TVal, class TAlloc = OdObjectsAllocator<TVal> >
class OdSlots : public OdArray<TVal, TAlloc>
{
  void ensureSpace(OdSlotId slotId)
  {
    if(slotId >= this->size())
    {
      this->resize(slotId+1);
    }
  }
public:
  typedef typename OdArray<TVal, TAlloc>::size_type size_type;
 
  OdSlots() {}

  OdSlots(size_type physicalLength, int growLength = 8)
    : OdArray<TVal, TAlloc>(physicalLength, growLength) {}

  static const TVal* emptySlotValue() { static const TVal def = TVal(); return &def; }

  const TVal& operator[](OdSlotId slotId) const
  {
    return (slotId < this->size() ? this->getPtr()[slotId] : *emptySlotValue());
  }

  TVal& operator[](OdSlotId slotId)
  {
    ensureSpace(slotId);
    return this->asArrayPtr()[slotId];
  }

  const TVal& getAt(OdSlotId slotId) const
  {
    return (slotId < this->size() ? this->getPtr()[slotId] : *emptySlotValue());
  }

  void setAt(OdSlotId slotId, const TVal& value)
  {
    ensureSpace(slotId);
    this->asArrayPtr()[slotId] = value;
  }
};
 

template <class TVal, class TAlloc = OdObjectsAllocator<TVal> >
class OdManagedSlots
  : public OdSlots<TVal, TAlloc>
  , public OdSlotManager
{
public:
  typedef typename OdSlots<TVal, TAlloc>::size_type size_type;

  OdManagedSlots() {}

  OdManagedSlots(size_type physicalLength, int growLength = 8)
    : OdSlots<TVal, TAlloc>(physicalLength, growLength) {}
 
#ifdef _DEBUG
  const TVal& operator[](OdSlotId slotId) const
  {
    ODA_ASSERT(OdSlotManager::contains(slotId)); // invalid slotId
    return OdSlots<TVal, TAlloc>::operator[](slotId);
  }
  TVal& operator[](OdSlotId slotId)
  {
    ODA_ASSERT(OdSlotManager::contains(slotId)); // invalid slotId
    return OdSlots<TVal, TAlloc>::operator[](slotId);
  }

  const TVal& getAt(OdSlotId slotId) const
  {
    ODA_ASSERT(OdSlotManager::contains(slotId)); // invalid slotId
    return OdSlots<TVal, TAlloc>::getAt(slotId);
  }
  void setAt(OdSlotId slotId, const TVal& value)
  {
    ODA_ASSERT(OdSlotManager::contains(slotId)); // invalid slotId
    OdSlots<TVal, TAlloc>::setAt(slotId, value);
  }
#endif //_DEBUG
};
 
#include "TD_PackPop.h"
 
#endif // #ifndef _SLOTMANAGER_H_INCLUDED_