/////////////////////////////////////////////////////////////////////////////// 
// Copyright (C) 2002-2019, 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-2019 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 ODDB_DBSUBENT_H
#define ODDB_DBSUBENT_H /*!DOM*/

#include "DbBaseSubentId.h"
#include "DbObjectId.h"
#include "IdArrays.h"
#define STL_USING_FUNCTIONAL
#include "OdaSTL.h"

/** \details
    This class uniquely defines subentities within in an OdDbDatabase instance.  

    \remarks
    Each OdDbFullSubentPath object consists of a OdDbSubentId object and
    an ordered array of Object IDs. The SubentId consists the index and subentType
    of the object. The array of Object IDs defines the path to the 
    subentity from the outermost entity (in PaperSpace or ModelSpace) 
    to the entity containing the subentity.
    
    Corresponding C++ library: TD_Db

    <group OdDb_Classes>
*/
class TOOLKIT_EXPORT OdDbFullSubentPath : public OdDbBaseFullSubentPath
{
public:
  OdDbFullSubentPath() 
  {
  }
  OdDbFullSubentPath(OdDb::SubentType type, OdGsMarker index)
    : OdDbBaseFullSubentPath(type, index)
  {
  }
  OdDbFullSubentPath(OdDbObjectId entId, OdDbSubentId subId)
    : OdDbBaseFullSubentPath(entId, subId)
  {
  }
  OdDbFullSubentPath(OdDbObjectId entId, OdDb::SubentType type, OdGsMarker index)
    : OdDbBaseFullSubentPath(entId, type, index)
  {
  }
  OdDbFullSubentPath(OdDbObjectIdArray objectIds, OdDbSubentId subId)
    : OdDbBaseFullSubentPath(*reinterpret_cast<OdDbStubPtrArray*>(&objectIds), subId)
  {
  }
  OdDbFullSubentPath(OdDbStubPtrArray objectIds, OdDbSubentId subId)
    : OdDbBaseFullSubentPath(objectIds, subId)
  {
  }
  /** \details
    Returns a reference to the embedded OdDbObjectIdArray object in this FullSubentPath object.
  */
  void objectIds(OdDbObjectIdArray& objectIdsArg) const
  {
    objectIdsArg = *reinterpret_cast<const OdDbObjectIdArray*>(&m_ObjectIds);
  }

  OdDbFullSubentPath& operator =(const OdDbFullSubentPath& fullSubentPath)
  {
    OdDbBaseFullSubentPath::operator=(fullSubentPath);
    return *this;
  }

  bool operator==(const OdDbFullSubentPath& fullSubentPath) const
  {
    return OdDbBaseFullSubentPath::operator==(fullSubentPath);
  }

  /** \details
    Returns a reference to the embedded OdDbObjectIdArray object in this FullSubentPath object.
  */
  const OdDbObjectIdArray& objectIds() const
  {
    return *reinterpret_cast<const OdDbObjectIdArray*>(&m_ObjectIds);
  }
  
  /** \details
    Returns a reference to the embedded OdDbObjectIdArray object in this FullSubentPath object.
  */
  OdDbObjectIdArray& objectIds()
  {
    return *reinterpret_cast<OdDbObjectIdArray*>(&m_ObjectIds);
  }
  
  /** \details
    Returns a copy of the embedded OdDbSubentId object in this FullSubentPath object.
  */
  const OdDbSubentId subentId() const
  {
    return m_SubentId;
  }

  /** \details
    Returns a reference to the embedded OdDbSubentId object in this FullSubentPath object.
  */
  OdDbSubentId& subentId()
  {
    return m_SubentId;
  }
  /** \details
  Less functor for using in std::set and std::map containers.

  \remarks
  Note that OdDbObjectId's are compared as pointers, and their ordering may change from run to run.
  Keep that in mind when iterating through a container.
  */
  struct less : std::binary_function<OdDbFullSubentPath, OdDbFullSubentPath, bool>
  {
    bool operator()(const OdDbFullSubentPath & fsp1, const OdDbFullSubentPath & fsp2) const
    {
      const OdDbSubentId & sid1 = fsp1.subentId();
      const OdDbSubentId & sid2 = fsp2.subentId();
      if (sid1.index() != sid2.index())
        return sid1.index() < sid2.index();
      if (sid1.type() != sid2.type())
        return sid1.type() < sid2.type();
      const OdDbObjectIdArray & oids1 = fsp1.objectIds();
      const OdDbObjectIdArray & oids2 = fsp2.objectIds();
      const int len1 = oids1.length();
      const int len2 = oids2.length();
      if (len1 != len2)
        return len1 < len2;
      for (int i = 0; i < len1; ++i)
      {
        const OdDbObjectId & oid1 = oids1[i];
        const OdDbObjectId & oid2 = oids2[i];
        if (oid1 != oid2)
          return oid1 < oid2;
      }
      return false;
    }
  };
};

/** \details
    This template class is a specialization of the OdArray class for OdDbFullSubentPath object pointers.
*/
typedef OdArray<OdDbFullSubentPath> OdDbFullSubentPathArray;

#endif