Open CASCADE Technology  6.7.1
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions
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).
More...

#include <IFSelect_PacketList.hxx>

Inheritance diagram for IFSelect_PacketList:
Inheritance graph
[legend]

Public Member Functions

 IFSelect_PacketList (const Handle< Interface_InterfaceModel > &model)
 Creates a PackList, empty, ready to receive entities from a
given Model
More...
 
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"
More...
 
Standard_CString Name () const
 Returns the recorded name for a packet list
More...
 
Handle_Interface_InterfaceModel Model () const
 Returns the Model of reference
More...
 
void AddPacket ()
 Declares a new Packet, ready to be filled
The entities to be added will be added to this Packet
More...
 
void Add (const Handle< Standard_Transient > &ent)
 Adds an entity from the Model into the current packet for Add
More...
 
void AddList (const Handle< TColStd_HSequenceOfTransient > &list)
 Adds an list of entities into the current packet for Add
More...
 
Standard_Integer NbPackets () const
 Returns the count of non-empty packets
More...
 
Standard_Integer NbEntities (const Standard_Integer numpack) const
 Returns the count of entities in a Packet given its rank, or 0
More...
 
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
More...
 
Standard_Integer HighestDuplicationCount () const
 Returns the highest number of packets which know a same entity
For no duplication, should be one
More...
 
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
More...
 
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)
More...
 
- Public Member Functions inherited from MMgt_TShared
virtual void Delete () const
 Memory deallocator for transient classes. More...
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor. More...
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing. More...
 
Standard_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter. More...
 
virtual ~Standard_Transient ()
 Destructor must be virtual. More...
 
virtual void ShallowDump (Standard_OStream &) const
 
virtual const
Handle_Standard_Type & 
DynamicType () const
 Returns a type information object about this object. More...
 
Standard_Boolean IsInstance (const Handle_Standard_Type &theType) const
 Returns a true value if this is an instance of Type. More...
 
Standard_Boolean IsInstance (const Standard_CString theTypeName) const
 Returns a true value if this is an instance of TypeName. More...
 
Standard_Boolean IsKind (const Handle_Standard_Type &theType) const
 Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More...
 
Standard_Boolean IsKind (const Standard_CString theTypeName) const
 Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More...
 
virtual Handle_Standard_Transient This () const
 Returns a Handle which references this object. Must never be called to objects created in stack. More...
 
Standard_Integer GetRefCount () const
 Get the reference counter of this object. More...
 

Detailed Description

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).

Constructor & Destructor Documentation

IFSelect_PacketList::IFSelect_PacketList ( const Handle< Interface_InterfaceModel > &  model)

Creates a PackList, empty, ready to receive entities from a
given Model

Member Function Documentation

void IFSelect_PacketList::Add ( const Handle< Standard_Transient > &  ent)

Adds an entity from the Model into the current packet for Add

void IFSelect_PacketList::AddList ( const Handle< TColStd_HSequenceOfTransient > &  list)

Adds an list of entities into the current packet for Add

void IFSelect_PacketList::AddPacket ( )

Declares a new Packet, ready to be filled
The entities to be added will be added to this Packet

Interface_EntityIterator IFSelect_PacketList::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)

Interface_EntityIterator IFSelect_PacketList::Entities ( const Standard_Integer  numpack) const

Returns the content of a Packet given its rank
Null Handle if <numpack> is out of range

Standard_Integer IFSelect_PacketList::HighestDuplicationCount ( ) const

Returns the highest number of packets which know a same entity
For no duplication, should be one

Handle_Interface_InterfaceModel IFSelect_PacketList::Model ( ) const

Returns the Model of reference

Standard_CString IFSelect_PacketList::Name ( ) const

Returns the recorded name for a packet list

Standard_Integer IFSelect_PacketList::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_Integer IFSelect_PacketList::NbEntities ( const Standard_Integer  numpack) const

Returns the count of entities in a Packet given its rank, or 0

Standard_Integer IFSelect_PacketList::NbPackets ( ) const

Returns the count of non-empty packets

void IFSelect_PacketList::SetName ( const Standard_CString  name)

Sets a name to a packet list : this makes easier a general
routine to print it. Default is "Packets"


The documentation for this class was generated from the following file: