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:

Public Member Functions
	IFSelect_PacketList (const occ::handle< Interface_InterfaceModel > &model)
	Creates a PackList, empty, ready to receive entities from a given Model.
void	SetName (const char *const namename)
	Sets a name to a packet list : this makes easier a general routine to print it. Default is "Packets".
const char *	Name () const
	Returns the recorded name for a packet list.
occ::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 occ::handle< Standard_Transient > &ent)
	Adds an entity from the Model into the current packet for Add.
void	AddList (const occ::handle< NCollection_HSequence< occ::handle< Standard_Transient > > > &list)
	Adds an list of entities into the current packet for Add.
int	NbPackets () const
	Returns the count of non-empty packets.
int	NbEntities (const int numpack) const
	Returns the count of entities in a Packet given its rank, or 0.
Interface_EntityIterator	Entities (const int numpack) const
	Returns the content of a Packet given its rank Null Handle if <numpack> is out of range.
int	HighestDuplicationCount () const
	Returns the highest number of packets which know a same entity For no duplication, should be one.
int	NbDuplicated (const int countcount, const bool 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 int countcount, const bool 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 ()=default
	Destructor must be virtual.
virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.
bool	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.
bool	IsInstance (const char *const theTypeName) const
	Returns a true value if this is an instance of TypeName.
bool	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.
bool	IsKind (const char *const 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.
int	GetRefCount () const noexcept
	Get the reference counter of this object.
void	IncrementRefCounter () noexcept
	Increments the reference counter of this object. Uses relaxed memory ordering since incrementing only requires atomicity, not synchronization with other memory operations.
int	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value. Uses release ordering for the decrement to ensure all writes to the object are visible before the count reaches zero. An acquire fence is added only when the count reaches zero, ensuring proper synchronization before deletion. This is more efficient than using acq_rel for every decrement.
virtual void	Delete () const
	Memory deallocator for transient classes.

Additional Inherited Members
typedef void	base_type
	Returns a type descriptor about this object.
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 occ::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 occ::handle< Standard_Transient > &

ent

)

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

AddList()

void IFSelect_PacketList::AddList

(

const occ::handle< NCollection_HSequence< occ::handle< Standard_Transient > > > &

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 int	count,
		const bool	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 int

numpack

)

const

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

HighestDuplicationCount()

int IFSelect_PacketList::HighestDuplicationCount

(

)

const

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

Model()

occ::handle< Interface_InterfaceModel > IFSelect_PacketList::Model

(

)

const

Returns the Model of reference.

Name()

const char * IFSelect_PacketList::Name

(

)

const

Returns the recorded name for a packet list.

NbDuplicated()

int IFSelect_PacketList::NbDuplicated	(	const int	count,
		const bool	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()

int IFSelect_PacketList::NbEntities

(

const int

numpack

)

const

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

NbPackets()

int IFSelect_PacketList::NbPackets

(

)

const

Returns the count of non-empty packets.

SetName()

void IFSelect_PacketList::SetName

(

const char *const

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:

• IFSelect_PacketList.hxx