IFSelect_SignatureList Class Reference

A SignatureList is given as result from a Counter (any kind) It gives access to a list of signatures, with counts, and optionally with list of corresponding entities. More...

#include <IFSelect_SignatureList.hxx>

Inheritance diagram for IFSelect_SignatureList:

Public Member Functions
	IFSelect_SignatureList (const bool withlist=false)
	Creates a SignatureList. If <withlist> is True, entities will be not only counted per signature, but also listed.
void	SetList (const bool withlist)
	Changes the record-list status. The list is not cleared but its use changes.
bool &	ModeSignOnly ()
	Returns modifiable the SignOnly Mode If False (D), the counter normally counts If True, the counting work is turned off, Add only fills the LastValue, which can be used as signature, when a counter works from data which are not available from a Signature.
virtual void	Clear ()
void	Add (const occ::handle< Standard_Transient > &ent, const char *const sign)
	Adds an entity with its signature, i.e. :
const char *	LastValue () const
	Returns the last value recorded by Add (only if SignMode set) Cleared by Clear or Init.
void	Init (const char *const name, const NCollection_IndexedDataMap< TCollection_AsciiString, int > &count, const NCollection_IndexedDataMap< TCollection_AsciiString, occ::handle< Standard_Transient > > &list, const int nbnuls)
	Acknowledges the list in once. Name identifies the Signature.
occ::handle< NCollection_HSequence< occ::handle< TCollection_HAsciiString > > >	List (const char *const root="") const
	Returns the list of signatures, as a sequence of strings (but without their respective counts). It is ordered. By default, for all the signatures. If <root> is given non empty, for the signatures which begin by <root>
bool	HasEntities () const
	Returns True if the list of Entities is acknowledged, else the method Entities will always return a Null Handle.
int	NbNulls () const
	Returns the count of null entities.
int	NbTimes (const char *const sign) const
	Returns the number of times a signature was counted, 0 if it has not been recorded at all.
occ::handle< NCollection_HSequence< occ::handle< Standard_Transient > > >	Entities (const char *const sign) const
	Returns the list of entities attached to a signature It is empty if <sign> has not been recorded It is a Null Handle if the list of entities is not known.
void	SetName (const char *const name)
	Defines a name for a SignatureList (used to print it)
virtual const char *	Name () const
	Returns the recorded Name. Remark : default is "..." (no SetName called)
virtual void	PrintCount (Standard_OStream &S) const
	Prints the counts of items (not the list)
virtual void	PrintList (Standard_OStream &S, const occ::handle< Interface_InterfaceModel > &model, const IFSelect_PrintCount mod=IFSelect_ListByItem) const
	Prints the lists of items, if they are present (else, prints a message "no list available") Uses <model> to determine for each entity to be listed, its number, and its specific identifier (by PrintLabel) <mod> gives a mode for printing :
virtual void	PrintSum (Standard_OStream &S) const
	Prints a summary Item which has the greatest count of entities For items which are numeric values : their count, maximum, minimum values, cumul, average.
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
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

A SignatureList is given as result from a Counter (any kind) It gives access to a list of signatures, with counts, and optionally with list of corresponding entities.

It can also be used only to give a signature, through SignOnly Mode. This can be useful for a specific counter (used in a Selection), while it remains better to use a Signature whenever possible

Constructor & Destructor Documentation

IFSelect_SignatureList()

IFSelect_SignatureList::IFSelect_SignatureList

(

const bool

withlist = false

)

Creates a SignatureList. If <withlist> is True, entities will be not only counted per signature, but also listed.

Member Function Documentation

Add()

void IFSelect_SignatureList::Add	(	const occ::handle< Standard_Transient > &	ent,
		const char *const	sign )

Adds an entity with its signature, i.e. :

• counts an item more for <sign>
• if record-list status is set, records the entity Accepts a null entity (the signature is then for the global model). But if the string is empty, counts a Null item.

If SignOnly Mode is set, this work is replaced by just setting LastValue

Clear()

virtual void IFSelect_SignatureList::Clear ( )

virtual

Reimplemented in IGESSelect_CounterOfLevelNumber.

Entities()

occ::handle< NCollection_HSequence< occ::handle< Standard_Transient > > > IFSelect_SignatureList::Entities

(

const char *const

sign

)

const

Returns the list of entities attached to a signature It is empty if <sign> has not been recorded It is a Null Handle if the list of entities is not known.

HasEntities()

bool IFSelect_SignatureList::HasEntities

(

)

const

Returns True if the list of Entities is acknowledged, else the method Entities will always return a Null Handle.

Init()

void IFSelect_SignatureList::Init	(	const char *const	name,
		const NCollection_IndexedDataMap< TCollection_AsciiString, int > &	count,
		const NCollection_IndexedDataMap< TCollection_AsciiString, occ::handle< Standard_Transient > > &	list,
		const int	nbnuls )

Acknowledges the list in once. Name identifies the Signature.

LastValue()

const char * IFSelect_SignatureList::LastValue

(

)

const

Returns the last value recorded by Add (only if SignMode set) Cleared by Clear or Init.

List()

occ::handle< NCollection_HSequence< occ::handle< TCollection_HAsciiString > > > IFSelect_SignatureList::List

(

const char *const

root = ""

)

const

Returns the list of signatures, as a sequence of strings (but without their respective counts). It is ordered. By default, for all the signatures. If <root> is given non empty, for the signatures which begin by <root>

ModeSignOnly()

bool & IFSelect_SignatureList::ModeSignOnly

(

)

Returns modifiable the SignOnly Mode If False (D), the counter normally counts If True, the counting work is turned off, Add only fills the LastValue, which can be used as signature, when a counter works from data which are not available from a Signature.

Name()

virtual const char * IFSelect_SignatureList::Name ( ) const

virtual

Returns the recorded Name. Remark : default is "..." (no SetName called)

NbNulls()

int IFSelect_SignatureList::NbNulls

(

)

const

Returns the count of null entities.

NbTimes()

int IFSelect_SignatureList::NbTimes

(

const char *const

sign

)

const

Returns the number of times a signature was counted, 0 if it has not been recorded at all.

PrintCount()

virtual void IFSelect_SignatureList::PrintCount ( Standard_OStream & S ) const

virtual

Prints the counts of items (not the list)

Reimplemented in IGESSelect_CounterOfLevelNumber.

PrintList()

virtual void IFSelect_SignatureList::PrintList ( Standard_OStream & S, const occ::handle< Interface_InterfaceModel > & model, const IFSelect_PrintCount mod = IFSelect_ListByItem ) const

virtual

Prints the lists of items, if they are present (else, prints a message "no list available") Uses <model> to determine for each entity to be listed, its number, and its specific identifier (by PrintLabel) <mod> gives a mode for printing :

• CountByItem : just count (as PrintCount)
• ShortByItem : minimum i.e. count plus 5 first entity numbers
• ShortByItem(D) complete list of entity numbers (0: "Global")
• EntitiesByItem : list of (entity number/PrintLabel from the model) other modes are ignored

PrintSum()

virtual void IFSelect_SignatureList::PrintSum ( Standard_OStream & S ) const

virtual

Prints a summary Item which has the greatest count of entities For items which are numeric values : their count, maximum, minimum values, cumul, average.

SetList()

void IFSelect_SignatureList::SetList

(

const bool

withlist

)

Changes the record-list status. The list is not cleared but its use changes.

SetName()

void IFSelect_SignatureList::SetName

(

const char *const

name

)

Defines a name for a SignatureList (used to print it)

---

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

• IFSelect_SignatureList.hxx