OCC Main Page | DataExchange | Toolkits | Packages | Class Hierarchy | Data Structures | File List | Data Fields | Globals

DataExchange
TKXSBase
IFSelect


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

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>

Inheritance diagram for IFSelect_SignatureList:

Inheritance graph
[legend]

Public Member Functions

Standard_EXPORT 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.
.
Standard_EXPORT void SetList (const Standard_Boolean withlist)
 Changes the record-list status. The list is not cleared but
its use changes
.
Standard_EXPORT 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 Standard_EXPORT void Clear ()
Standard_EXPORT void Add (const Handle(Standard_Transient)&ent, const Standard_CString 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
.
Standard_EXPORT Standard_CString LastValue () const
 Returns the last value recorded by Add (only if SignMode set)
Cleared by Clear or Init
.
Standard_EXPORT 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
.
Standard_EXPORT 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_EXPORT Standard_Boolean HasEntities () const
 Returns True if the list of Entities is aknowledged, else
the method Entities will always return a Null Handle
.
Standard_EXPORT Standard_Integer NbNulls () const
 Returns the count of null entities
.
Standard_EXPORT 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
.
Standard_EXPORT 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
.
Standard_EXPORT void SetName (const Standard_CString name)
 Defines a name for a SignatureList (used to print it)
.
virtual Standard_EXPORT Standard_CString Name () const
 Returns the recorded Name.
Remark : default is "..." (no SetName called)
.
virtual Standard_EXPORT void PrintCount (const Handle(Message_Messenger)&S) const
 Prints the counts of items (not the list)
.
virtual Standard_EXPORT 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 :
- 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
.
virtual Standard_EXPORT 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
.
Standard_EXPORT const Handle (Standard_Type)&DynamicType() const

Private Attributes

Standard_Boolean thesignonly
Standard_Boolean thelistat
Standard_Integer thenbnuls
Handle_TCollection_HAsciiString thename
TCollection_AsciiString thelastval
Handle_Dico_DictionaryOfInteger thedicount
Handle_Dico_DictionaryOfTransient thediclist

Constructor & Destructor Documentation

Standard_EXPORT IFSelect_SignatureList::IFSelect_SignatureList const Standard_Boolean  withlist = Standard_False  ) 
 


Member Function Documentation

Standard_EXPORT void IFSelect_SignatureList::Add const Handle(Standard_Transient)&  ent,
const Standard_CString  sign
 

virtual Standard_EXPORT void IFSelect_SignatureList::Clear  )  [virtual]
 

Reimplemented in IGESSelect_CounterOfLevelNumber.

Standard_EXPORT Handle_TColStd_HSequenceOfTransient IFSelect_SignatureList::Entities const Standard_CString  sign  )  const
 

Standard_EXPORT const IFSelect_SignatureList::Handle Standard_Type   )  const
 

Reimplemented in IFSelect_CheckCounter, IFSelect_GraphCounter, IFSelect_SignCounter, and IGESSelect_CounterOfLevelNumber.

Standard_EXPORT Standard_Boolean IFSelect_SignatureList::HasEntities  )  const
 

Standard_EXPORT void IFSelect_SignatureList::Init const Standard_CString  name,
const Handle(Dico_DictionaryOfInteger)&  count,
const Handle(Dico_DictionaryOfTransient)&  list,
const Standard_Integer  nbnuls
 

Standard_EXPORT Standard_CString IFSelect_SignatureList::LastValue  )  const
 

Standard_EXPORT Handle_TColStd_HSequenceOfHAsciiString IFSelect_SignatureList::List const Standard_CString  root = ""  )  const
 

Standard_EXPORT Standard_Boolean& IFSelect_SignatureList::ModeSignOnly  ) 
 

virtual Standard_EXPORT Standard_CString IFSelect_SignatureList::Name  )  const [virtual]
 

Standard_EXPORT Standard_Integer IFSelect_SignatureList::NbNulls  )  const
 

Standard_EXPORT Standard_Integer IFSelect_SignatureList::NbTimes const Standard_CString  sign  )  const
 

virtual Standard_EXPORT void IFSelect_SignatureList::PrintCount const Handle(Message_Messenger)&  S  )  const [virtual]
 

Reimplemented in IGESSelect_CounterOfLevelNumber.

virtual Standard_EXPORT void IFSelect_SignatureList::PrintList const Handle(Message_Messenger)&  S,
const Handle(Interface_InterfaceModel)&  model,
const IFSelect_PrintCount  mod = IFSelect_ListByItem
const [virtual]
 

virtual Standard_EXPORT void IFSelect_SignatureList::PrintSum const Handle(Message_Messenger)&  S  )  const [virtual]
 

Standard_EXPORT void IFSelect_SignatureList::SetList const Standard_Boolean  withlist  ) 
 

Standard_EXPORT void IFSelect_SignatureList::SetName const Standard_CString  name  ) 
 


Field Documentation

Handle_Dico_DictionaryOfTransient IFSelect_SignatureList::thediclist [private]
 

Handle_Dico_DictionaryOfInteger IFSelect_SignatureList::thedicount [private]
 

TCollection_AsciiString IFSelect_SignatureList::thelastval [private]
 

Standard_Boolean IFSelect_SignatureList::thelistat [private]
 

Handle_TCollection_HAsciiString IFSelect_SignatureList::thename [private]
 

Standard_Integer IFSelect_SignatureList::thenbnuls [private]
 

Standard_Boolean IFSelect_SignatureList::thesignonly [private]
 


The documentation for this class was generated from the following file:
Generated on Mon Aug 25 14:39:58 2008 for OpenCASCADE by  doxygen 1.4.1