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

The dictionnary interface. More...

#include <IDictionnary.h>

Inheritance diagram for DriveEngine::IDictionnary:
DriveEngine::ICollection IExportable DriveEngine::ICalibrationInfoList DriveEngine::IFeature3DCloud DriveEngine::IMatch DriveEngine::DefaultCalibrationInfoList DriveEngine::DefaultFeature3DCloud DriveEngine::DefaultMatch

Public Member Functions

virtual IExportableGetElement (const IExportable &key) const =0
 Gets an element. More...
 
virtual const IExportableGetConstElement (const IExportable &key) const =0
 Gets a constant element. More...
 
virtual void Add (const IExportable &key, IExportable &element)=0
 Adds an element. More...
 
virtual void Remove (const IExportable &key)=0
 Removes an element, if found. Oterwise, nothing is done. More...
 
virtual void AddDictionnary (const IDictionnary &dictionnary)=0
 Adds every element from an other dictionnary. More...
 
virtual void RemoveDictionnary (const IDictionnary &dictionnary)=0
 Removes every element common to an other dictionnary. 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 dictionnary interface.

Represents an associative list, that is a list of key-value pairs. The key and the value must be instances of IExportable.

Member Function Documentation

virtual void DriveEngine::IDictionnary::Add ( const IExportable key,
IExportable element 
)
pure virtual

Adds an element.

If the new element has the same key that an old element, the new element will replace the old one.

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

Parameters
keyThe key of the element. The key must not be null.
elementThe element to add. The element must not be null.
virtual void DriveEngine::IDictionnary::AddDictionnary ( const IDictionnary dictionnary)
pure virtual

Adds every element from an other dictionnary.

If a new element has the same key that an old element, the new element will replace the old one.

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

Parameters
dictionnaryThe dictionnary containing elements to add. The dictionnary must not be null.
virtual const IExportable* DriveEngine::IDictionnary::GetConstElement ( const IExportable key) const
pure virtual

Gets a constant element.

If the element cannot be found, a null element is returned.

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

Parameters
keyThe key of the element. If the key is null, a precondition is thrown.
Returns
The constant element. If it cannot be found, returns nullptr.
virtual IExportable* DriveEngine::IDictionnary::GetElement ( const IExportable key) const
pure virtual

Gets an element.

If the element cannot be found, a null element is returned.

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

Parameters
keyThe key of the element. If the key is null, a precondition is thrown.
Returns
The element. If it cannot be found, returns nullptr.
virtual void DriveEngine::IDictionnary::Remove ( const IExportable key)
pure virtual

Removes an element, if found. Oterwise, nothing is done.

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

Parameters
keyThe key of the element. The key must not be null.
virtual void DriveEngine::IDictionnary::RemoveDictionnary ( const IDictionnary dictionnary)
pure virtual

Removes every element common to an other dictionnary.

Only the key are used to determine if elements are common. Non- common elements are ignored.

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

Parameters
dictionnaryThe dictionnary containing elements to remove. The dictionnary must not be null.

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