Open CASCADE Technology  7.3.1.dev
Public Member Functions
IFSelect_Dispatch Class Referenceabstract

This class allows to describe how a set of Entities has to be dispatched into resulting Packets : a Packet is a sub-set of the initial set of entities. More...

#include <IFSelect_Dispatch.hxx>

Inheritance diagram for IFSelect_Dispatch:
Inheritance graph
[legend]

Public Member Functions

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...
 
virtual Standard_Boolean LimitedMax (const Standard_Integer nbent, Standard_Integer &max) const
 Returns True if a Dispatch generates a count of Packets always less than or equal to a maximum value : it can be computed from the total count of Entities to be dispatched : <nbent>. If answer is False, no limited maximum is expected for account If answer is True, expected maximum is given in argument <max> Default answer given here is False (can be redefined) More...
 
virtual TCollection_AsciiString Label () const =0
 Returns a text which defines the way a Dispatch produces packets (which will become files) from its Input. 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...
 
virtual void Packets (const Interface_Graph &G, IFGraph_SubPartsIterator &packs) const =0
 Returns the list of produced Packets into argument <pack>. Each Packet corresponds to a Part, the Entities listed are the Roots given by the Selection. Input is given as a Graph. Thus, to create a file from a packet, it suffices to take the entities listed in a Part of Packets (that is, a Packet) without worrying about Shared entities This method can raise an Exception if data are not coherent. 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 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

This class allows to describe how a set of Entities has to be dispatched into resulting Packets : a Packet is a sub-set of the initial set of entities.

Thus, it can generate zero, one, or more Packets according input set and criterium of dispatching. And it can let apart some entities : it is the Remainder, which can be recovered by a specific Selection (RemainderFromDispatch).

Depending of sub-classes, a Dispatch can potentially generate a limited or not count of packet, and a remainder or none.

The input set is read from a specified Selection, attached to the Dispatch : the Final Selection of the Dispatch. The input is the Unique Root Entities list of the Final Selection

Member Function Documentation

◆ CanHaveRemainder()

virtual Standard_Boolean IFSelect_Dispatch::CanHaveRemainder ( ) const
virtual

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)

Reimplemented in IGESSelect_DispPerDrawing, and IGESSelect_DispPerSingleView.

◆ FinalSelection()

Handle< IFSelect_Selection > IFSelect_Dispatch::FinalSelection ( ) const

Returns the Final Selection of a Dispatch we 'd like : C++ : return const &.

◆ GetEntities()

Interface_EntityIterator IFSelect_Dispatch::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)

◆ HasRootName()

Standard_Boolean IFSelect_Dispatch::HasRootName ( ) const

Returns True if a specific Root Name has been set (else, the Default Root Name has to be used)

◆ Label()

virtual TCollection_AsciiString IFSelect_Dispatch::Label ( ) const
pure virtual

Returns a text which defines the way a Dispatch produces packets (which will become files) from its Input.

Implemented in IFSelect_DispPerFiles, IFSelect_DispPerSignature, IFSelect_DispPerCount, IGESSelect_DispPerDrawing, IGESSelect_DispPerSingleView, IFSelect_DispPerOne, and IFSelect_DispGlobal.

◆ LimitedMax()

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

Returns True if a Dispatch generates a count of Packets always less than or equal to a maximum value : it can be computed from the total count of Entities to be dispatched : <nbent>. If answer is False, no limited maximum is expected for account If answer is True, expected maximum is given in argument <max> Default answer given here is False (can be redefined)

Reimplemented in IFSelect_DispPerFiles, IFSelect_DispPerSignature, IFSelect_DispPerCount, IFSelect_DispPerOne, and IFSelect_DispGlobal.

◆ Packeted()

Interface_EntityIterator IFSelect_Dispatch::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.

◆ Packets()

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

Returns the list of produced Packets into argument <pack>. Each Packet corresponds to a Part, the Entities listed are the Roots given by the Selection. Input is given as a Graph. Thus, to create a file from a packet, it suffices to take the entities listed in a Part of Packets (that is, a Packet) without worrying about Shared entities This method can raise an Exception if data are not coherent.

Implemented in IFSelect_DispPerFiles, IFSelect_DispPerSignature, IFSelect_DispPerCount, IGESSelect_DispPerDrawing, IGESSelect_DispPerSingleView, IFSelect_DispGlobal, and IFSelect_DispPerOne.

◆ Remainder()

virtual Interface_EntityIterator IFSelect_Dispatch::Remainder ( const Interface_Graph G) const
virtual

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).

Reimplemented in IGESSelect_DispPerDrawing, and IGESSelect_DispPerSingleView.

◆ RootName()

const Handle< TCollection_HAsciiString >& IFSelect_Dispatch::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.

◆ Selections()

IFSelect_SelectionIterator IFSelect_Dispatch::Selections ( ) const

Returns the complete list of source Selections (starting from FinalSelection)

◆ SetFinalSelection()

void IFSelect_Dispatch::SetFinalSelection ( const Handle< IFSelect_Selection > &  sel)

Stores (or Changes) the Final Selection for a Dispatch.

◆ SetRootName()

void IFSelect_Dispatch::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)


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