This class allows to memorize and access to the modifiers which are to be applied to a file. To each modifier, is bound a list of integers (optionnal) : if this list is absent, the modifier applies to all the file. Else, it applies to the entities designated by these numbers in the produced file. More...
#include <IFSelect_AppliedModifiers.hxx>
Public Member Functions | |
| IFSelect_AppliedModifiers (const Standard_Integer nbmax, const Standard_Integer nbent) | |
| Creates an AppliedModifiers, ready to record up to <nbmax> modifiers, on a model of <nbent> entities. More... | |
| Standard_Boolean | AddModif (const Handle< IFSelect_GeneralModifier > &modif) |
| Records a modifier. By default, it is to apply on all a produced file. Further calls to AddNum will restrict this. Returns True if done, False if too many modifiers are already recorded. More... | |
| Standard_Boolean | AddNum (const Standard_Integer nument) |
| Adds a number of entity of the output file to be applied on. If a sequence of AddNum is called after AddModif, this Modifier will be applied on the list of designated entities. Else, it will be applied on all the file Returns True if done, False if no modifier has yet been added. More... | |
| Standard_Integer | Count () const |
| Returns the count of recorded modifiers. More... | |
| Standard_Boolean | Item (const Standard_Integer num, Handle< IFSelect_GeneralModifier > &modif, Standard_Integer &entcount) |
| Returns the description for applied modifier n0 <num> : the modifier itself, and the count of entities to be applied on. If no specific list of number has been defined, returns the total count of entities of the file If this count is zero, then the modifier applies to all the file (see below). Else, the numbers are then queried by calls to ItemNum between 1 and <entcount> Returns True if OK, False if <num> is out of range. More... | |
| Standard_Integer | ItemNum (const Standard_Integer nument) const |
| Returns a numero of entity to be applied on, given its rank in the list. If no list is defined (i.e. for all the file), returns <nument> itself, to give all the entities of the file Returns 0 if <nument> out of range. More... | |
| Handle< TColStd_HSequenceOfInteger > | ItemList () const |
| Returns the list of entities to be applied on (see Item) as a HSequence (IsForAll produces the complete list of all the entity numbers of the file. More... | |
| Standard_Boolean | IsForAll () const |
| Returns True if the applied modifier queried by last call to Item is to be applied to all the produced file. Else, <entcount> returned by Item gives the count of entity numbers, each one is queried by ItemNum. More... | |
 Public Member Functions inherited from MMgt_TShared | |
| virtual void | Delete () const override |
| Memory deallocator for transient classes. More... | |
| Public Member Functions inherited from Standard_Transient | |
| Standard_Transient () | |
| Empty constructor. More... | |
| Standard_Transient (const Standard_Transient &) | |
| Copy constructor – does nothing. More... | |
| Standard_Transient & | operator= (const Standard_Transient &) |
| Assignment operator, needed to avoid copying reference counter. More... | |
| virtual | ~Standard_Transient () |
| Destructor must be virtual. 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_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. 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
This class allows to memorize and access to the modifiers which are to be applied to a file. To each modifier, is bound a list of integers (optionnal) : if this list is absent, the modifier applies to all the file. Else, it applies to the entities designated by these numbers in the produced file.
To record a modifier, and a possible list of entity numbers to be applied on : AddModif (amodifier); loop on AddNum (anumber);
To query it, Count gives the count of recorded modifiers, then for each one : Item (numodif, amodifier, entcount); IsForAll () -> can be called, if True, applies on the whole file
for (i = 1; i <= entcount; i ++) nument = ItemNum (i); -> return an entity number
Constructor & Destructor Documentation
| IFSelect_AppliedModifiers::IFSelect_AppliedModifiers | ( | const Standard_Integer | nbmax, |
| const Standard_Integer | nbent | ||
| ) |
Creates an AppliedModifiers, ready to record up to <nbmax> modifiers, on a model of <nbent> entities.
Member Function Documentation
| Standard_Boolean IFSelect_AppliedModifiers::AddModif | ( | const Handle< IFSelect_GeneralModifier > & | modif | ) |
Records a modifier. By default, it is to apply on all a produced file. Further calls to AddNum will restrict this. Returns True if done, False if too many modifiers are already recorded.
| Standard_Boolean IFSelect_AppliedModifiers::AddNum | ( | const Standard_Integer | nument | ) |
Adds a number of entity of the output file to be applied on. If a sequence of AddNum is called after AddModif, this Modifier will be applied on the list of designated entities. Else, it will be applied on all the file Returns True if done, False if no modifier has yet been added.
| Standard_Integer IFSelect_AppliedModifiers::Count | ( | ) | const |
Returns the count of recorded modifiers.
| Standard_Boolean IFSelect_AppliedModifiers::IsForAll | ( | ) | const |
Returns True if the applied modifier queried by last call to Item is to be applied to all the produced file. Else, <entcount> returned by Item gives the count of entity numbers, each one is queried by ItemNum.
| Standard_Boolean IFSelect_AppliedModifiers::Item | ( | const Standard_Integer | num, |
| Handle< IFSelect_GeneralModifier > & | modif, | ||
| Standard_Integer & | entcount | ||
| ) |
Returns the description for applied modifier n0 <num> : the modifier itself, and the count of entities to be applied on. If no specific list of number has been defined, returns the total count of entities of the file If this count is zero, then the modifier applies to all the file (see below). Else, the numbers are then queried by calls to ItemNum between 1 and <entcount> Returns True if OK, False if <num> is out of range.
| Handle< TColStd_HSequenceOfInteger > IFSelect_AppliedModifiers::ItemList | ( | ) | const |
Returns the list of entities to be applied on (see Item) as a HSequence (IsForAll produces the complete list of all the entity numbers of the file.
| Standard_Integer IFSelect_AppliedModifiers::ItemNum | ( | const Standard_Integer | nument | ) | const |
Returns a numero of entity to be applied on, given its rank in the list. If no list is defined (i.e. for all the file), returns <nument> itself, to give all the entities of the file Returns 0 if <nument> out of range.
The documentation for this class was generated from the following file:
