Defines general form for classes of graph algorithms on Interfaces, this form is that of EntityIterator Each sub-class fills it according to its own algorithm This also allows to combine any graph result to others, all being given under one unique form. More...
#include <Interface_GraphContent.hxx>
Public Member Functions | |
| Interface_GraphContent () | |
| Creates an empty GraphContent, ready to be filled. More... | |
| Interface_GraphContent (const Interface_Graph &agraph) | |
| Creates with all entities designated by a Graph. More... | |
| Interface_GraphContent (const Interface_Graph &agraph, const Standard_Integer stat) | |
| Creates with entities having specific Status value in a Graph. More... | |
| Interface_GraphContent (const Interface_Graph &agraph, const Handle< Standard_Transient > &ent) | |
| Creates an Iterator with Shared entities of an entity (equivalente to EntityIterator but with a Graph) More... | |
| void | GetFromGraph (const Interface_Graph &agraph) |
| Gets all Entities designated by a Graph (once created), adds them to those already recorded. More... | |
| void | GetFromGraph (const Interface_Graph &agraph, const Standard_Integer stat) |
| Gets entities from a graph which have a specific Status value (one created), adds them to those already recorded. More... | |
| Interface_EntityIterator | Result () |
| Returns Result under the exact form of an EntityIterator : Can be used when EntityIterator itself is required (as a returned value for instance), without way for a sub-class. More... | |
| void | Begin () |
| Does the Evaluation before starting the iteration itself (in out) More... | |
| virtual void | Evaluate () |
| Evaluates list of Entities to be iterated. Called by Start Default is set to doing nothing : intended to be redefined by each sub-class. More... | |
 Public Member Functions inherited from Interface_EntityIterator | |
| Interface_EntityIterator () | |
| Defines an empty iterator (see AddList & AddItem) More... | |
| Interface_EntityIterator (const Handle< TColStd_HSequenceOfTransient > &list) | |
| Defines an iterator on a list, directly i.e. without copying it. More... | |
| void | AddList (const Handle< TColStd_HSequenceOfTransient > &list) |
| Gets a list of entities and adds its to the iteration list. More... | |
| void | AddItem (const Handle< Standard_Transient > &anentity) |
| Adds to the iteration list a defined entity. More... | |
| void | GetOneItem (const Handle< Standard_Transient > &anentity) |
| same as AddItem (kept for compatibility) More... | |
| void | SelectType (const Handle< Standard_Type > &atype, const Standard_Boolean keep) |
| Selects entities with are Kind of a given type, keep only them (is keep is True) or reject only them (if keep is False) More... | |
| Standard_Integer | NbEntities () const |
| Returns count of entities which will be iterated on Calls Start if not yet done. More... | |
| Standard_Integer | NbTyped (const Handle< Standard_Type > &type) const |
| Returns count of entities of a given type (kind of) More... | |
| Interface_EntityIterator | Typed (const Handle< Standard_Type > &type) const |
| Returns the list of entities of a given type (kind of) More... | |
| virtual void | Start () const |
| Allows re-iteration (useless for the first iteration) More... | |
| Standard_Boolean | More () const |
| Says if there are other entities (vertices) to iterate the first time, calls Start. More... | |
| void | Next () const |
| Sets iteration to the next entity (vertex) to give. More... | |
| const Handle< Standard_Transient > & | Value () const |
| Returns the current Entity iterated, to be used by Interface tools. More... | |
| Handle< TColStd_HSequenceOfTransient > | Content () const |
| Returns the content of the Iterator, accessed through a Handle to be used by a frontal-engine logic Returns an empty Sequence if the Iterator is empty Calls Start if not yet done. More... | |
| void | Destroy () |
| Clears data of iteration. More... | |
| virtual | ~Interface_EntityIterator () |
| Destructor. More... | |
Additional Inherited Members | |
| Protected Member Functions inherited from Interface_EntityIterator | |
| void | Reset () |
| Allows subclasses of EntityIterator to reevaluate an iteration. More... | |
Detailed Description
Defines general form for classes of graph algorithms on Interfaces, this form is that of EntityIterator Each sub-class fills it according to its own algorithm This also allows to combine any graph result to others, all being given under one unique form.
Constructor & Destructor Documentation
◆ Interface_GraphContent() [1/4]
| Interface_GraphContent::Interface_GraphContent | ( | ) |
Creates an empty GraphContent, ready to be filled.
◆ Interface_GraphContent() [2/4]
| Interface_GraphContent::Interface_GraphContent | ( | const Interface_Graph & | agraph | ) |
Creates with all entities designated by a Graph.
◆ Interface_GraphContent() [3/4]
| Interface_GraphContent::Interface_GraphContent | ( | const Interface_Graph & | agraph, |
| const Standard_Integer | stat | ||
| ) |
Creates with entities having specific Status value in a Graph.
◆ Interface_GraphContent() [4/4]
| Interface_GraphContent::Interface_GraphContent | ( | const Interface_Graph & | agraph, |
| const Handle< Standard_Transient > & | ent | ||
| ) |
Creates an Iterator with Shared entities of an entity (equivalente to EntityIterator but with a Graph)
Member Function Documentation
◆ Begin()
| void Interface_GraphContent::Begin | ( | ) |
Does the Evaluation before starting the iteration itself (in out)
◆ Evaluate()
|
virtual |
Evaluates list of Entities to be iterated. Called by Start Default is set to doing nothing : intended to be redefined by each sub-class.
Reimplemented in IFGraph_ExternalSources, IFGraph_Cumulate, IFGraph_Compare, IFGraph_Articulations, IFGraph_AllShared, and IFGraph_AllConnected.
◆ GetFromGraph() [1/2]
| void Interface_GraphContent::GetFromGraph | ( | const Interface_Graph & | agraph | ) |
Gets all Entities designated by a Graph (once created), adds them to those already recorded.
◆ GetFromGraph() [2/2]
| void Interface_GraphContent::GetFromGraph | ( | const Interface_Graph & | agraph, |
| const Standard_Integer | stat | ||
| ) |
Gets entities from a graph which have a specific Status value (one created), adds them to those already recorded.
◆ Result()
| Interface_EntityIterator Interface_GraphContent::Result | ( | ) |
Returns Result under the exact form of an EntityIterator : Can be used when EntityIterator itself is required (as a returned value for instance), without way for a sub-class.
The documentation for this class was generated from the following file:
