Open CASCADE Technology  7.6.0.dev
Public Member Functions
Interface_EntityList Class Reference

This class defines a list of Entities (Transient Objects), it can be used as a field of other Transient classes, with these features : More...

#include <Interface_EntityList.hxx>

Public Member Functions

 Interface_EntityList ()
 Creates a List as beeing empty. More...
 
void Clear ()
 Clears the List. More...
 
void Append (const Handle< Standard_Transient > &ent)
 Appends an Entity, that is to the END of the list (keeps order, but works slowerly than Add, see below) More...
 
void Add (const Handle< Standard_Transient > &ent)
 Adds an Entity to the list, that is, with NO REGARD about the order (faster than Append if count becomes greater than 10) More...
 
void Remove (const Handle< Standard_Transient > &ent)
 Removes an Entity from the list, if it is there. More...
 
void Remove (const Standard_Integer num)
 Removes an Entity from the list, given its rank. More...
 
Standard_Boolean IsEmpty () const
 Returns True if the list is empty. More...
 
Standard_Integer NbEntities () const
 Returns count of recorded Entities. More...
 
const Handle< Standard_Transient > & Value (const Standard_Integer num) const
 Returns an Item given its number. Beware about the way the list was filled (see above, Add and Append) More...
 
void SetValue (const Standard_Integer num, const Handle< Standard_Transient > &ent)
 Returns an Item given its number. Beware about the way the list was filled (see above, Add and Append) More...
 
void FillIterator (Interface_EntityIterator &iter) const
 fills an Iterator with the content of the list (normal way to consult a list which has been filled with Add) More...
 
Standard_Integer NbTypedEntities (const Handle< Standard_Type > &atype) const
 Returns count of Entities of a given Type (0 : none) More...
 
Handle< Standard_TransientTypedEntity (const Handle< Standard_Type > &atype, const Standard_Integer num=0) const
 Returns the Entity which is of a given type. If num = 0 (D), there must be ONE AND ONLY ONE If num > 0, returns the num-th entity of this type. More...
 

Detailed Description

This class defines a list of Entities (Transient Objects), it can be used as a field of other Transient classes, with these features :

Works in conjunction with EntityCluster An EntityList gives access to a list of Entity Clusters, which are chained (in one sense : Single List) Remark : a new Item may not be Null, because this is the criterium used for "End of List"

Constructor & Destructor Documentation

◆ Interface_EntityList()

Interface_EntityList::Interface_EntityList ( )

Creates a List as beeing empty.

Member Function Documentation

◆ Add()

void Interface_EntityList::Add ( const Handle< Standard_Transient > &  ent)

Adds an Entity to the list, that is, with NO REGARD about the order (faster than Append if count becomes greater than 10)

◆ Append()

void Interface_EntityList::Append ( const Handle< Standard_Transient > &  ent)

Appends an Entity, that is to the END of the list (keeps order, but works slowerly than Add, see below)

◆ Clear()

void Interface_EntityList::Clear ( )

Clears the List.

◆ FillIterator()

void Interface_EntityList::FillIterator ( Interface_EntityIterator iter) const

fills an Iterator with the content of the list (normal way to consult a list which has been filled with Add)

◆ IsEmpty()

Standard_Boolean Interface_EntityList::IsEmpty ( ) const

Returns True if the list is empty.

◆ NbEntities()

Standard_Integer Interface_EntityList::NbEntities ( ) const

Returns count of recorded Entities.

◆ NbTypedEntities()

Standard_Integer Interface_EntityList::NbTypedEntities ( const Handle< Standard_Type > &  atype) const

Returns count of Entities of a given Type (0 : none)

◆ Remove() [1/2]

void Interface_EntityList::Remove ( const Handle< Standard_Transient > &  ent)

Removes an Entity from the list, if it is there.

◆ Remove() [2/2]

void Interface_EntityList::Remove ( const Standard_Integer  num)

Removes an Entity from the list, given its rank.

◆ SetValue()

void Interface_EntityList::SetValue ( const Standard_Integer  num,
const Handle< Standard_Transient > &  ent 
)

Returns an Item given its number. Beware about the way the list was filled (see above, Add and Append)

◆ TypedEntity()

Handle< Standard_Transient > Interface_EntityList::TypedEntity ( const Handle< Standard_Type > &  atype,
const Standard_Integer  num = 0 
) const

Returns the Entity which is of a given type. If num = 0 (D), there must be ONE AND ONLY ONE If num > 0, returns the num-th entity of this type.

◆ Value()

const Handle< Standard_Transient >& Interface_EntityList::Value ( const Standard_Integer  num) const

Returns an Item given its number. Beware about the way the list was filled (see above, Add and Append)


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