EIC code displayed by LXR master/​include/​opencascade/​Interface_EntityCluster.hxx	Source navigation Diff markup Identifier search General search
	Version: master test Revert   Change

File indexing completed on 2025-01-18 10:04:07

 // Created on: 1992-11-02
 // Created by: Christian CAILLET
 // Copyright (c) 1992-1999 Matra Datavision
 // Copyright (c) 1999-2014 OPEN CASCADE SAS
 //
 // This file is part of Open CASCADE Technology software library.
 //
 // This library is free software; you can redistribute it and/or modify it under
 // the terms of the GNU Lesser General Public License version 2.1 as published
 // by the Free Software Foundation, with special exception defined in the file
 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
 // distribution for complete text of the license and disclaimer of any warranty.
 //
 // Alternatively, this file may be used under the terms of Open CASCADE
 // commercial license or contractual agreement.
 
 #ifndef _Interface_EntityCluster_HeaderFile
 #define _Interface_EntityCluster_HeaderFile
 
 #include <Standard.hxx>
 #include <Standard_Type.hxx>
 
 #include <Standard_Transient.hxx>
 #include <Standard_Integer.hxx>
 class Interface_EntityIterator;
 
 
 class Interface_EntityCluster;
 DEFINE_STANDARD_HANDLE(Interface_EntityCluster, Standard_Transient)
 
 //! Auxiliary class for EntityList. An EntityList designates an
 //! EntityCluster, which brings itself an fixed maximum count of
 //! Entities. If it is full, it gives access to another cluster
 //! ("Next"). This class is intended to give a good compromise
 //! between access time (faster than a Sequence, good for little
 //! count) and memory use (better than a Sequence in any case,
 //! overall for little count, better than an Array for a very
 //! little count. It is designed for a light management.
 //! Remark that a new Item may not be Null, because this is the
 //! criterium used for "End of List"
 class Interface_EntityCluster : public Standard_Transient
 {
 
 public:
 
   
   //! Creates an empty, non-chained, EntityCluster
   Standard_EXPORT Interface_EntityCluster();
   
   //! Creates a non-chained EntityCluster, filled with one Entity
   Standard_EXPORT Interface_EntityCluster(const Handle(Standard_Transient)& ent);
   
   //! Creates an empty EntityCluster, chained with another one
   //! (that is, put BEFORE this other one in the list)
   Standard_EXPORT Interface_EntityCluster(const Handle(Interface_EntityCluster)& ec);
   
   //! Creates an EntityCluster, filled with a first Entity, and
   //! chained to another EntityCluster (BEFORE it, as above)
   Standard_EXPORT Interface_EntityCluster(const Handle(Standard_Transient)& ant, const Handle(Interface_EntityCluster)& ec);
   
   //! Appends an Entity to the Cluster. If it is not full, adds the
   //! entity directly inside itself. Else, transmits to its Next
   //! and Creates it if it does not yet exist
   Standard_EXPORT void Append (const Handle(Standard_Transient)& ent);
   
   //! Removes an Entity from the Cluster. If it is not found, calls
   //! its Next one to do so.
   //! Returns True if it becomes itself empty, False else
   //! (thus, a Cluster which becomes empty is deleted from the list)
   Standard_EXPORT Standard_Boolean Remove (const Handle(Standard_Transient)& ent);
   
   //! Removes an Entity from the Cluster, given its rank. If <num>
   //! is greater than NbLocal, calls its Next with (num - NbLocal),
   //! Returns True if it becomes itself empty, False else
   Standard_EXPORT Standard_Boolean Remove (const Standard_Integer num);
   
   //! Returns total count of Entities (including Next)
   Standard_EXPORT Standard_Integer NbEntities() const;
   
   //! Returns the Entity identified by its rank in the list
   //! (including Next)
   Standard_EXPORT const Handle(Standard_Transient)& Value (const Standard_Integer num) const;
   
   //! Changes an Entity given its rank.
   Standard_EXPORT void SetValue (const Standard_Integer num, const Handle(Standard_Transient)& ent);
   
   //! Fills an Iterator with designated Entities (includes Next)
   Standard_EXPORT void FillIterator (Interface_EntityIterator& iter) const;
 
   //! Destructor 
   //! If Next exists, destroy from the last entity in reverse order.
   Standard_EXPORT virtual ~Interface_EntityCluster();
 
 friend class Interface_EntityList;
 
 
   DEFINE_STANDARD_RTTIEXT(Interface_EntityCluster,Standard_Transient)
 
 protected:
 
 
 
 
 private:
 
   
   //! Returns True if all the set of entities local to a Cluster is
   //! full. Used by EntityList.
   Standard_EXPORT Standard_Boolean IsLocalFull() const;
   
   //! Returns count of entities in the local set (without Next)
   //! Entities can then be read normally by method Value
   Standard_EXPORT Standard_Integer NbLocal() const;
   
   //! Returns True if a Cluster has a Next
   Standard_EXPORT Standard_Boolean HasNext() const;
   
   //! Returns Next Cluster in the chain
   Standard_EXPORT Handle(Interface_EntityCluster) Next() const;
 
   Handle(Standard_Transient) theents[4];
   Handle(Interface_EntityCluster) thenext;
 
 
 };
 
 
 
 
 
 
 
 #endif // _Interface_EntityCluster_HeaderFile

This page was automatically generated by the 2.3.7 LXR engine. The LXR team