Open CASCADE Technology  7.3.1.dev
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. 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_InterfaceModelModel () 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 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 Delete () const
 Memory deallocator for transient classes. More...
 
virtual const opencascade::handle< Standard_Type > & DynamicType () const
 Returns a type descriptor about this object. More...
 
Standard_Boolean IsInstance (const opencascade::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 opencascade::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...
 
Standard_TransientThis () const
 Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero. More...
 
Standard_Integer GetRefCount () const
 Get the reference counter of this object. More...
 
void IncrementRefCounter () const
 Increments the reference counter of this object. More...
 
Standard_Integer DecrementRefCounter () const
 Decrements the reference counter of this object; returns the decremented value. More...
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object. More...
 
- Static Public Member Functions inherited from Standard_Transient
static const char * get_type_name ()
 Returns a type descriptor about this object. More...
 
static const opencascade::handle< Standard_Type > & get_type_descriptor ()
 Returns type descriptor of Standard_Transient class. 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::IFSelect_PacketList ( const Handle< Interface_InterfaceModel > &  model)

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

Member Function Documentation

◆ Add()

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

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

◆ AddList()

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

Adds an list of entities into the current packet for Add.

◆ AddPacket()

void IFSelect_PacketList::AddPacket ( )

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

◆ Duplicated()

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)

◆ Entities()

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.

◆ HighestDuplicationCount()

Standard_Integer IFSelect_PacketList::HighestDuplicationCount ( ) const

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

◆ Model()

Handle< Interface_InterfaceModel > IFSelect_PacketList::Model ( ) const

Returns the Model of reference.

◆ Name()

Standard_CString IFSelect_PacketList::Name ( ) const

Returns the recorded name for a packet list.

◆ NbDuplicated()

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.

◆ NbEntities()

Standard_Integer IFSelect_PacketList::NbEntities ( const Standard_Integer  numpack) const

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

◆ NbPackets()

Standard_Integer IFSelect_PacketList::NbPackets ( ) const

Returns the count of non-empty packets.

◆ SetName()

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: