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

DataExchange
TKXSBase
IFSelect


IFSelect_AppliedModifiers Class Reference

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
.

#include <IFSelect_AppliedModifiers.hxx>


Public Member Functions

Standard_EXPORT 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
.
Standard_EXPORT 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
.
Standard_EXPORT 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
.
Standard_EXPORT Standard_Integer Count () const
 Returns the count of recorded modifiers
.
Standard_EXPORT 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
.
Standard_EXPORT 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
.
Standard_EXPORT 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
.
Standard_EXPORT 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
.
Standard_EXPORT const Handle (Standard_Type)&DynamicType() const

Private Attributes

IFSelect_SequenceOfGeneralModifier themodifs
Interface_IntList thelists
Standard_Integer thenbent
Standard_Integer theentcnt


Constructor & Destructor Documentation

Standard_EXPORT IFSelect_AppliedModifiers::IFSelect_AppliedModifiers const Standard_Integer  nbmax,
const Standard_Integer  nbent
 


Member Function Documentation

Standard_EXPORT Standard_Boolean IFSelect_AppliedModifiers::AddModif const Handle(IFSelect_GeneralModifier)&  modif  ) 
 

Standard_EXPORT Standard_Boolean IFSelect_AppliedModifiers::AddNum const Standard_Integer  nument  ) 
 

Standard_EXPORT Standard_Integer IFSelect_AppliedModifiers::Count  )  const
 

Standard_EXPORT const IFSelect_AppliedModifiers::Handle Standard_Type   )  const
 

Standard_EXPORT Standard_Boolean IFSelect_AppliedModifiers::IsForAll  )  const
 

Standard_EXPORT Standard_Boolean IFSelect_AppliedModifiers::Item const Standard_Integer  num,
Handle(IFSelect_GeneralModifier)&  modif,
Standard_Integer &  entcount
 

Standard_EXPORT Handle_TColStd_HSequenceOfInteger IFSelect_AppliedModifiers::ItemList  )  const
 

Standard_EXPORT Standard_Integer IFSelect_AppliedModifiers::ItemNum const Standard_Integer  nument  )  const
 


Field Documentation

Standard_Integer IFSelect_AppliedModifiers::theentcnt [private]
 

Interface_IntList IFSelect_AppliedModifiers::thelists [private]
 

IFSelect_SequenceOfGeneralModifier IFSelect_AppliedModifiers::themodifs [private]
 

Standard_Integer IFSelect_AppliedModifiers::thenbent [private]
 


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