OCC Main Page | DataExchange | Toolkits | Packages | Class Hierarchy | Data Structures | File List | Data Fields | Globals

DataExchange
TKXSBase
IFSelect


IFSelect_PacketList Class Reference

This class gives a simple way to return then consult a
list of packets, determined from the content of a Model,
by various criteria.

It allows to describe several lists with entities from a
given model, possibly more than one list knowing every entity,
and to determine the remaining list (entities in no lists) and
the duplications (with their count).
.

#include <IFSelect_PacketList.hxx>


Public Member Functions

Standard_EXPORT IFSelect_PacketList (const Handle(Interface_InterfaceModel)&model)
 Creates a PackList, empty, ready to receive entities from a
given Model
.
Standard_EXPORT void SetName (const Standard_CString name)
 Sets a name to a packet list : this makes easier a general
routine to print it. Default is "Packets"
.
Standard_EXPORT Standard_CString Name () const
 Returns the recorded name for a packet list
.
Standard_EXPORT Handle_Interface_InterfaceModel Model () const
 Returns the Model of reference
.
Standard_EXPORT void AddPacket ()
 Declares a new Packet, ready to be filled
The entities to be added will be added to this Packet
.
Standard_EXPORT void Add (const Handle(Standard_Transient)&ent)
 Adds an entity from the Model into the current packet for Add
.
Standard_EXPORT void AddList (const Handle(TColStd_HSequenceOfTransient)&list)
 Adds an list of entities into the current packet for Add
.
Standard_EXPORT Standard_Integer NbPackets () const
 Returns the count of non-empty packets
.
Standard_EXPORT Standard_Integer NbEntities (const Standard_Integer numpack) const
 Returns the count of entities in a Packet given its rank, or 0
.
Standard_EXPORT Interface_EntityIterator Entities (const Standard_Integer numpack) const
 Returns the content of a Packet given its rank
Null Handle if <numpack> is out of range
.
Standard_EXPORT Standard_Integer HighestDuplicationCount () const
 Returns the highest number of packets which know a same entity
For no duplication, should be one
.
Standard_EXPORT Standard_Integer NbDuplicated (const Standard_Integer count, const Standard_Boolean andmore) const
 Returns the count of entities duplicated :
<count> times, if <andmore> is False, or
<count> or more times, if <andmore> is True
See Duplicated for more details
.
Standard_EXPORT Interface_EntityIterator Duplicated (const Standard_Integer count, const Standard_Boolean andmore) const
 Returns a list of entities duplicated :
<count> times, if <andmore> is False, or
<count> or more times, if <andmore> is True
Hence, count=2 & andmore=True gives all duplicated entities
count=1 gives non-duplicated entities (in only one packet)
count=0 gives remaining entities (in no packet at all)
.
Standard_EXPORT const Handle (Standard_Type)&DynamicType() const

Private Attributes

Handle_Interface_InterfaceModel themodel
TColStd_Array1OfInteger thedupls
Interface_IntList thepacks
TColStd_Array1OfInteger theflags
Standard_Integer thelast
Standard_Boolean thebegin
TCollection_AsciiString thename


Constructor & Destructor Documentation

Standard_EXPORT IFSelect_PacketList::IFSelect_PacketList const Handle(Interface_InterfaceModel)&  model  ) 
 


Member Function Documentation

Standard_EXPORT void IFSelect_PacketList::Add const Handle(Standard_Transient)&  ent  ) 
 

Standard_EXPORT void IFSelect_PacketList::AddList const Handle(TColStd_HSequenceOfTransient)&  list  ) 
 

Standard_EXPORT void IFSelect_PacketList::AddPacket  ) 
 

Standard_EXPORT Interface_EntityIterator IFSelect_PacketList::Duplicated const Standard_Integer  count,
const Standard_Boolean  andmore
const
 

Standard_EXPORT Interface_EntityIterator IFSelect_PacketList::Entities const Standard_Integer  numpack  )  const
 

Standard_EXPORT const IFSelect_PacketList::Handle Standard_Type   )  const
 

Standard_EXPORT Standard_Integer IFSelect_PacketList::HighestDuplicationCount  )  const
 

Standard_EXPORT Handle_Interface_InterfaceModel IFSelect_PacketList::Model  )  const
 

Standard_EXPORT Standard_CString IFSelect_PacketList::Name  )  const
 

Standard_EXPORT Standard_Integer IFSelect_PacketList::NbDuplicated const Standard_Integer  count,
const Standard_Boolean  andmore
const
 

Standard_EXPORT Standard_Integer IFSelect_PacketList::NbEntities const Standard_Integer  numpack  )  const
 

Standard_EXPORT Standard_Integer IFSelect_PacketList::NbPackets  )  const
 

Standard_EXPORT void IFSelect_PacketList::SetName const Standard_CString  name  ) 
 


Field Documentation

Standard_Boolean IFSelect_PacketList::thebegin [private]
 

TColStd_Array1OfInteger IFSelect_PacketList::thedupls [private]
 

TColStd_Array1OfInteger IFSelect_PacketList::theflags [private]
 

Standard_Integer IFSelect_PacketList::thelast [private]
 

Handle_Interface_InterfaceModel IFSelect_PacketList::themodel [private]
 

TCollection_AsciiString IFSelect_PacketList::thename [private]
 

Interface_IntList IFSelect_PacketList::thepacks [private]
 


The documentation for this class was generated from the following file:
Generated on Mon Aug 25 14:39:45 2008 for OpenCASCADE by  doxygen 1.4.1