Open CASCADE Technology
6.5.4
|
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
#include <IFSelect_SignatureList.hxx>
Public Member Functions | |
IFSelect_SignatureList (const Standard_Boolean withlist=Standard_False) | |
Creates a SignatureList. If <withlist> is True, entities will be not only counted per signature, but also listed. | |
void | SetList (const Standard_Boolean withlist) |
Changes the record-list status. The list is not cleared but its use changes | |
Standard_Boolean & | 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 Handle< Standard_Transient > &ent, const Standard_CString sign) |
Adds an entity with its signature, i.e. : | |
Standard_CString | LastValue () const |
Returns the last value recorded by Add (only if SignMode set) Cleared by Clear or Init | |
void | Init (const Standard_CString name, const Handle< Dico_DictionaryOfInteger > &count, const Handle< Dico_DictionaryOfTransient > &list, const Standard_Integer nbnuls) |
Aknowledges the list in once. Name identifies the Signature | |
Handle_TColStd_HSequenceOfHAsciiString | List (const Standard_CString 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> | |
Standard_Boolean | HasEntities () const |
Returns True if the list of Entities is aknowledged, else the method Entities will always return a Null Handle | |
Standard_Integer | NbNulls () const |
Returns the count of null entities | |
Standard_Integer | NbTimes (const Standard_CString sign) const |
Returns the number of times a signature was counted, 0 if it has not been recorded at all | |
Handle_TColStd_HSequenceOfTransient | Entities (const Standard_CString 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 Standard_CString name) |
Defines a name for a SignatureList (used to print it) | |
virtual Standard_CString | Name () const |
Returns the recorded Name. Remark : default is "..." (no SetName called) | |
virtual void | PrintCount (const Handle< Message_Messenger > &S) const |
Prints the counts of items (not the list) | |
virtual void | PrintList (const Handle< Message_Messenger > &S, const 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 (const Handle< Message_Messenger > &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 |
void IFSelect_SignatureList::Add | ( | const Handle< Standard_Transient > & | ent, |
const Standard_CString | sign | ||
) |
- counts an item more for <sign> <br> - if record-list status is set, records the entity <br> Accepts a null entity (the signature is then for the global <br> model). But if the string is empty, counts a Null item. <br>
If SignOnly Mode is set, this work is replaced by just
setting LastValue
virtual void IFSelect_SignatureList::Clear | ( | ) | [virtual] |
Reimplemented in IGESSelect_CounterOfLevelNumber.
Handle_TColStd_HSequenceOfTransient IFSelect_SignatureList::Entities | ( | const Standard_CString | sign | ) | const |
void IFSelect_SignatureList::Init | ( | const Standard_CString | name, |
const Handle< Dico_DictionaryOfInteger > & | count, | ||
const Handle< Dico_DictionaryOfTransient > & | list, | ||
const Standard_Integer | nbnuls | ||
) |
Handle_TColStd_HSequenceOfHAsciiString IFSelect_SignatureList::List | ( | const Standard_CString | root = "" | ) | const |
virtual Standard_CString IFSelect_SignatureList::Name | ( | ) | const [virtual] |
Standard_Integer IFSelect_SignatureList::NbTimes | ( | const Standard_CString | sign | ) | const |
virtual void IFSelect_SignatureList::PrintCount | ( | const Handle< Message_Messenger > & | S | ) | const [virtual] |
Reimplemented in IGESSelect_CounterOfLevelNumber.
virtual void IFSelect_SignatureList::PrintList | ( | const Handle< Message_Messenger > & | S, |
const Handle< Interface_InterfaceModel > & | model, | ||
const IFSelect_PrintCount | mod = IFSelect_ListByItem |
||
) | const [virtual] |
virtual void IFSelect_SignatureList::PrintSum | ( | const Handle< Message_Messenger > & | S | ) | const [virtual] |
void IFSelect_SignatureList::SetList | ( | const Standard_Boolean | withlist | ) |