Open CASCADE Technology  7.3.0
Public Member Functions
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:
Inheritance graph
[legend]

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. More...
 
void SetList (const Standard_Boolean withlist)
 Changes the record-list status. The list is not cleared but its use changes. More...
 
Standard_BooleanModeSignOnly ()
 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. More...
 
virtual void Clear ()
 
void Add (const Handle< Standard_Transient > &ent, const Standard_CString sign)
 Adds an entity with its signature, i.e. : More...
 
Standard_CString LastValue () const
 Returns the last value recorded by Add (only if SignMode set) Cleared by Clear or Init. More...
 
void Init (const Standard_CString name, const NCollection_IndexedDataMap< TCollection_AsciiString, Standard_Integer > &count, const NCollection_IndexedDataMap< TCollection_AsciiString, Handle< Standard_Transient >> &list, const Standard_Integer nbnuls)
 Aknowledges the list in once. Name identifies the Signature. More...
 
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> More...
 
Standard_Boolean HasEntities () const
 Returns True if the list of Entities is aknowledged, else the method Entities will always return a Null Handle. More...
 
Standard_Integer NbNulls () const
 Returns the count of null entities. More...
 
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. More...
 
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. More...
 
void SetName (const Standard_CString name)
 Defines a name for a SignatureList (used to print it) More...
 
virtual Standard_CString Name () const
 Returns the recorded Name. Remark : default is "..." (no SetName called) More...
 
virtual void PrintCount (const Handle< Message_Messenger > &S) const
 Prints the counts of items (not the list) More...
 
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 : More...
 
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. More...
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor. More...
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing. More...
 
Standard_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter. More...
 
virtual ~Standard_Transient ()
 Destructor must be virtual. More...
 
virtual void Delete () const
 Memory deallocator for transient classes. More...
 
virtual const opencascade::handle< Standard_Type > & DynamicType () const
 Returns a type descriptor about this object. More...
 
Standard_Boolean IsInstance (const opencascade::handle< Standard_Type > &theType) const
 Returns a true value if this is an instance of Type. More...
 
Standard_Boolean IsInstance (const Standard_CString theTypeName) const
 Returns a true value if this is an instance of TypeName. More...
 
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. More...
 
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. More...
 
Standard_TransientThis () 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. More...
 
Standard_Integer GetRefCount () const
 Get the reference counter of this object. More...
 
void IncrementRefCounter () const
 Increments the reference counter of this object. More...
 
Standard_Integer DecrementRefCounter () const
 Decrements the reference counter of this object; returns the decremented value. More...
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object. More...
 
- Static Public Member Functions inherited from Standard_Transient
static const char * get_type_name ()
 Returns a type descriptor about this object. More...
 
static const opencascade::handle< Standard_Type > & get_type_descriptor ()
 Returns type descriptor of Standard_Transient class. More...
 

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 Standard_Boolean  withlist = Standard_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 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

◆ Clear()

virtual void IFSelect_SignatureList::Clear ( )
virtual

◆ Entities()

Handle< TColStd_HSequenceOfTransient > IFSelect_SignatureList::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.

◆ HasEntities()

Standard_Boolean IFSelect_SignatureList::HasEntities ( ) const

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

◆ Init()

void IFSelect_SignatureList::Init ( const Standard_CString  name,
const NCollection_IndexedDataMap< TCollection_AsciiString, Standard_Integer > &  count,
const NCollection_IndexedDataMap< TCollection_AsciiString, Handle< Standard_Transient >> &  list,
const Standard_Integer  nbnuls 
)

Aknowledges the list in once. Name identifies the Signature.

◆ LastValue()

Standard_CString IFSelect_SignatureList::LastValue ( ) const

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

◆ List()

Handle< TColStd_HSequenceOfHAsciiString > IFSelect_SignatureList::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>

◆ ModeSignOnly()

Standard_Boolean& 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 Standard_CString IFSelect_SignatureList::Name ( ) const
virtual

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

◆ NbNulls()

Standard_Integer IFSelect_SignatureList::NbNulls ( ) const

Returns the count of null entities.

◆ NbTimes()

Standard_Integer IFSelect_SignatureList::NbTimes ( const Standard_CString  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 ( const Handle< Message_Messenger > &  S) const
virtual

Prints the counts of items (not the list)

Reimplemented in IGESSelect_CounterOfLevelNumber.

◆ PrintList()

virtual void IFSelect_SignatureList::PrintList ( const Handle< Message_Messenger > &  S,
const 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 ( const Handle< Message_Messenger > &  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 Standard_Boolean  withlist)

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

◆ SetName()

void IFSelect_SignatureList::SetName ( const Standard_CString  name)

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


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