Drive Engine  1.0.0
Plateforme de reconstruction 3D
DriveEngine::ICollection Class Referenceabstract

The collection interface. More...

#include <ICollection.h>

Inheritance diagram for DriveEngine::ICollection:
IExportable DriveEngine::IDictionnary DriveEngine::IList DriveEngine::ICalibrationInfoList DriveEngine::IFeature3DCloud DriveEngine::IMatch DriveEngine::IFeature2DList DriveEngine::IFeature2DListOfList DriveEngine::IImageList DriveEngine::IMatchList DriveEngine::IParameterList DriveEngine::IPosition2DList

Public Member Functions

virtual Size GetSize () const =0
 Gets the size, that is the number of elements contained in the collection. More...
 
virtual bool IsEmpty () const =0
 Verify if the collection is empty. More...
 
virtual IEnumeratorGetEnumerator () const =0
 Gets an enumerator. More...
 
virtual IConstEnumeratorGetConstEnumerator () const =0
 Gets a constant enumerator. More...
 
virtual void Clear ()=0
 Remove every element contained in the collection. More...
 
- Public Member Functions inherited from IExportable
virtual void Delete () const =0
 Deletes the current object. Needed for memory management. More...
 

Detailed Description

The collection interface.

Every collection planned to be used by the framework must extends this interface.

A collection does not contain objects, but references to them. A collection is not responsible to delete objects. A bad use could lead to a memory leak.

Member Function Documentation

virtual void DriveEngine::ICollection::Clear ( )
pure virtual

Remove every element contained in the collection.

Exception safety : No-throw guarantee. This member function never throws exceptions.

Implemented in DriveEngine::DefaultParameterList.

virtual IConstEnumerator* DriveEngine::ICollection::GetConstEnumerator ( ) const
pure virtual

Gets a constant enumerator.

Exception safety : No-throw guarantee. This member function never throws exceptions. Is the responsability of developper to free the memory occupied by enumerator after it use. Otherwise a memory leak is created.

Returns
A constant enumerator.

Implemented in DriveEngine::DefaultParameterList.

virtual IEnumerator* DriveEngine::ICollection::GetEnumerator ( ) const
pure virtual

Gets an enumerator.

Exception safety : No-throw guarantee. This member function never throws exceptions. Is the responsability of developper to free the memory occupied by enumerator after it use. Otherwise a memory leak is created.

Returns
An enumerator.

Implemented in DriveEngine::DefaultParameterList.

virtual Size DriveEngine::ICollection::GetSize ( ) const
pure virtual

Gets the size, that is the number of elements contained in the collection.

Exception safety : No-throw guarantee. This member function never throws exceptions.

Returns
The size.

Implemented in DriveEngine::DefaultParameterList.

virtual bool DriveEngine::ICollection::IsEmpty ( ) const
pure virtual

Verify if the collection is empty.

Exception safety : No-throw guarantee. This member function never throws exceptions.

Returns
True if empty, false if not.

Implemented in DriveEngine::DefaultParameterList.


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