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

The match list interface. More...

#include <IMatchList.h>

Inheritance diagram for DriveEngine::IMatchList:
DriveEngine::IList DriveEngine::ICollection IExportable DriveEngine::DefaultMatchList

Public Member Functions

virtual IMatchGetIMatch (Index index) const =0
 Get a match. More...
 
virtual void Add (IMatch &match)=0
 Add a match. More...
 
virtual void Remove (IMatch &match)=0
 Remove a match. More...
 
- Public Member Functions inherited from DriveEngine::IList
virtual IExportableGetElement (Index index) const =0
 Gets an element. More...
 
virtual const IExportableGetConstElement (Index index) const =0
 Gets a constant element. More...
 
virtual void Add (IExportable &element)=0
 Adds an element. More...
 
virtual void Remove (IExportable &element)=0
 Removes an element. More...
 
virtual void AddList (const IList &list)=0
 Adds every element of a list. More...
 
virtual void RemoveList (const IList &list)=0
 Remove every element of a list. More...
 
- Public Member Functions inherited from DriveEngine::ICollection
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 match list interface.

Member Function Documentation

virtual void DriveEngine::IMatchList::Add ( IMatch match)
pure virtual

Add a match.

Exception safety : Strong exception safety. This member function throws exceptions.

Parameters
matchThe match to add. It must not be null.
virtual IMatch* DriveEngine::IMatchList::GetIMatch ( Index  index) const
pure virtual

Get a match.

Exception safety : Strong exception safety. This member function throws exceptions.

Parameters
indexThe index. It must be positive and must not exceed the size of the list.
Returns
The match. On error, returns nullptr.
virtual void DriveEngine::IMatchList::Remove ( IMatch match)
pure virtual

Remove a match.

If the match is not found, do nothing.

Exception safety : Strong exception safety. This member function throws exceptions.

Parameters
matchThe match to remove. It must not be null.

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