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>
Public Member Functions | |
| IFSelect_PacketList (const Handle< Interface_InterfaceModel > &model) | |
| Creates a PackList, empty, ready to receive entities from a given Model. | |
| 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_CString | Name () const |
| Returns the recorded name for a packet list. | |
| Handle< Interface_InterfaceModel > | Model () const |
| Returns the Model of reference. | |
| void | AddPacket () |
| Declares a new Packet, ready to be filled The entities to be added will be added to this Packet. | |
| void | Add (const Handle< Standard_Transient > &ent) |
| Adds an entity from the Model into the current packet for Add. | |
| void | AddList (const Handle< TColStd_HSequenceOfTransient > &list) |
| Adds an list of entities into the current packet for Add. | |
| Standard_Integer | NbPackets () const |
| Returns the count of non-empty packets. | |
| Standard_Integer | NbEntities (const Standard_Integer numpack) const |
| Returns the count of entities in a Packet given its rank, or 0. | |
| 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_Integer | HighestDuplicationCount () const |
| Returns the highest number of packets which know a same entity For no duplication, should be one. | |
| 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. | |
| 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) | |
 Public Member Functions inherited from Standard_Transient | |
| Standard_Transient () | |
| Empty constructor. | |
| Standard_Transient (const Standard_Transient &) | |
| Copy constructor – does nothing. | |
| Standard_Transient & | operator= (const Standard_Transient &) |
| Assignment operator, needed to avoid copying reference counter. | |
| virtual | ~Standard_Transient () |
| Destructor must be virtual. | |
| virtual const opencascade::handle< Standard_Type > & | DynamicType () const |
| Returns a type descriptor about this object. | |
| Standard_Boolean | IsInstance (const opencascade::handle< Standard_Type > &theType) const |
| Returns a true value if this is an instance of Type. | |
| Standard_Boolean | IsInstance (const Standard_CString theTypeName) const |
| Returns a true value if this is an instance of TypeName. | |
| 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. | |
| 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. | |
| Standard_Transient * | This () 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. | |
| Standard_Integer | GetRefCount () const noexcept |
| Get the reference counter of this object. | |
| void | IncrementRefCounter () noexcept |
| Increments the reference counter of this object. | |
| Standard_Integer | DecrementRefCounter () noexcept |
| Decrements the reference counter of this object; returns the decremented value. | |
| virtual void | Delete () const |
| Memory deallocator for transient classes. | |
Additional Inherited Members | |
| Public Types inherited from Standard_Transient | |
| typedef void | base_type |
| Returns a type descriptor about this object. | |
| Static Public Member Functions inherited from Standard_Transient | |
| static constexpr const char * | get_type_name () |
| Returns a type descriptor about this object. | |
| static const opencascade::handle< Standard_Type > & | get_type_descriptor () |
| Returns type descriptor of Standard_Transient class. | |
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:
