Open CASCADE Technology  6.9.0
Public Member Functions

IFSelect_DispPerFiles Class Reference

A DispPerFiles produces a determined count of Packets from the input Entities. It divides, as equally as possible, the input list into a count of files. This count is the parameter of the DispPerFiles. If the input list has less than this count, of course there will be one packet per input entity. This count is a Parameter of the DispPerFiles, given as an IntParam, thus allowing external control of its Value. More...

#include <IFSelect_DispPerFiles.hxx>

Inheritance diagram for IFSelect_DispPerFiles:
Inheritance graph
[legend]

Public Member Functions

 IFSelect_DispPerFiles ()
 Creates a DispPerFiles with no Count (default value 1 file) More...
 
Handle< IFSelect_IntParamCount () const
 Returns the Count Parameter used for splitting. More...
 
void SetCount (const Handle< IFSelect_IntParam > &count)
 Sets a new Parameter for Count. More...
 
Standard_Integer CountValue () const
 Returns the effective value of the count parameter (if Count Parameter not Set or value not positive, returns 1) More...
 
TCollection_AsciiString Label () const
 Returns as Label, "Maximum <count> Files". More...
 
virtual Standard_Boolean LimitedMax (const Standard_Integer nbent, Standard_Integer &max) const
 Returns True, maximum count is given as CountValue. More...
 
virtual Standard_Boolean PacketsCount (const Interface_Graph &G, Standard_Integer &count) const
 Returns True (count is easy to know) and count is the minimum value between length of input list and CountValue. More...
 
void Packets (const Interface_Graph &G, IFGraph_SubPartsIterator &packs) const
 Computes the list of produced Packets. It defines Packets in order to have <Count> Packets, except if the input count of Entities is lower. Entities are given by RootResult from the Final Selection. More...
 
- Public Member Functions inherited from IFSelect_Dispatch
void SetRootName (const Handle< TCollection_HAsciiString > &name)
 Sets a Root Name as an HAsciiString To reset it, give a Null Handle (then, a ShareOut will have to define the Default Root Name) More...
 
Standard_Boolean HasRootName () const
 Returns True if a specific Root Name has been set (else, the Default Root Name has to be used) More...
 
const Handle
< TCollection_HAsciiString > & 
RootName () const
 Returns the Root Name for files produced by this dispatch It is empty if it has not been set or if it has been reset. More...
 
void SetFinalSelection (const Handle< IFSelect_Selection > &sel)
 Stores (or Changes) the Final Selection for a Dispatch. More...
 
Handle< IFSelect_SelectionFinalSelection () const
 Returns the Final Selection of a Dispatch we 'd like : C++ : return const &. More...
 
IFSelect_SelectionIterator Selections () const
 Returns the complete list of source Selections (starting from FinalSelection) More...
 
virtual Standard_Boolean CanHaveRemainder () const
 Returns True if a Dispatch can have a Remainder, i.e. if its criterium can let entities apart. It is a potential answer, remainder can be empty at run-time even if answer is True. (to attach a RemainderFromDispatch Selection is not allowed if answer is True). Default answer given here is False (can be redefined) More...
 
Interface_EntityIterator GetEntities (const Interface_Graph &G) const
 Gets Unique Root Entities from the Final Selection, given an input Graph This the starting step for an Evaluation (Packets - Remainder) More...
 
Interface_EntityIterator Packeted (const Interface_Graph &G) const
 Returns the list of all Input Entities (see GetEntities) which are put in a Packet. That is, Entities listed in GetEntities but not in Remainder (see below). Input is given as a Graph. More...
 
virtual Interface_EntityIterator Remainder (const Interface_Graph &G) const
 Returns Remainder which is a set of Entities. Can be empty. Default evaluation is empty (has to be redefined if CanHaveRemainder is redefined to return True). More...
 
- Public Member Functions inherited from MMgt_TShared
virtual void Delete () const
 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_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter. More...
 
virtual ~Standard_Transient ()
 Destructor must be virtual. More...
 
virtual const
Handle_Standard_Type & 
DynamicType () const
 Returns a type information object about this object. More...
 
Standard_Boolean IsInstance (const 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 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...
 
virtual Handle_Standard_Transient This () const
 Returns a Handle which references this object. Must never be called to objects created in stack. More...
 
Standard_Integer GetRefCount () const
 Get the reference counter of this object. More...
 

Detailed Description

A DispPerFiles produces a determined count of Packets from the input Entities. It divides, as equally as possible, the input list into a count of files. This count is the parameter of the DispPerFiles. If the input list has less than this count, of course there will be one packet per input entity. This count is a Parameter of the DispPerFiles, given as an IntParam, thus allowing external control of its Value.

Constructor & Destructor Documentation

IFSelect_DispPerFiles::IFSelect_DispPerFiles ( )

Creates a DispPerFiles with no Count (default value 1 file)

Member Function Documentation

Handle< IFSelect_IntParam > IFSelect_DispPerFiles::Count ( ) const

Returns the Count Parameter used for splitting.

Standard_Integer IFSelect_DispPerFiles::CountValue ( ) const

Returns the effective value of the count parameter (if Count Parameter not Set or value not positive, returns 1)

TCollection_AsciiString IFSelect_DispPerFiles::Label ( ) const
virtual

Returns as Label, "Maximum <count> Files".

Implements IFSelect_Dispatch.

virtual Standard_Boolean IFSelect_DispPerFiles::LimitedMax ( const Standard_Integer  nbent,
Standard_Integer max 
) const
virtual

Returns True, maximum count is given as CountValue.

Reimplemented from IFSelect_Dispatch.

void IFSelect_DispPerFiles::Packets ( const Interface_Graph G,
IFGraph_SubPartsIterator packs 
) const
virtual

Computes the list of produced Packets. It defines Packets in order to have <Count> Packets, except if the input count of Entities is lower. Entities are given by RootResult from the Final Selection.

Implements IFSelect_Dispatch.

virtual Standard_Boolean IFSelect_DispPerFiles::PacketsCount ( const Interface_Graph G,
Standard_Integer count 
) const
virtual

Returns True (count is easy to know) and count is the minimum value between length of input list and CountValue.

Reimplemented from IFSelect_Dispatch.

void IFSelect_DispPerFiles::SetCount ( const Handle< IFSelect_IntParam > &  count)

Sets a new Parameter for Count.


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