DriveEngine::IList Class Reference

The list interface. More...

#include <IList.h>

Inheritance diagram for DriveEngine::IList:

Public Member Functions
virtual IExportable *	GetElement (Index index) const =0
	Gets an element. More...
virtual const IExportable *	GetConstElement (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 IEnumerator *	GetEnumerator () const =0
	Gets an enumerator. More...
virtual IConstEnumerator *	GetConstEnumerator () 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 list interface.

The elements must be an instance of IExportable.

Member Function Documentation

virtual void DriveEngine::IList::Add ( IExportable &  element )

pure virtual

Adds an element.

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

Parameters

element

The element to add. The element must not be null.

Implemented in DriveEngine::DefaultParameterList.

virtual void DriveEngine::IList::AddList ( const IList &  list )

pure virtual

Adds every element of a list.

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

Parameters

list	The list of elements to add. The list must not be null.

Implemented in DriveEngine::DefaultParameterList.

virtual const IExportable* DriveEngine::IList::GetConstElement ( Index  index ) const

pure virtual

Gets a constant element.

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

Parameters

index

The index of the element. The index must be positive an should not exceed the size of the list. Otherwise, a precondition exception is thrown.

Returns

The constant element. On error, returns nullptr.

Implemented in DriveEngine::DefaultParameterList.

virtual IExportable* DriveEngine::IList::GetElement ( Index  index ) const

pure virtual

Gets an element.

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

Parameters

index

The index of the element. The index must be positive an should not exceed the size of the list. Otherwise, a precondition exception is thrown.

Returns

The element. On error, returns nullptr.

Implemented in DriveEngine::DefaultParameterList.

virtual void DriveEngine::IList::Remove ( IExportable &  element )

pure virtual

Removes an element.

If the element is not found, do nothing.

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

Parameters

element

The element to remove. The element must not be null.

Implemented in DriveEngine::DefaultParameterList.

virtual void DriveEngine::IList::RemoveList ( const IList &  list )

pure virtual

Remove every element of a list.

Ignore element that are not contained in the list.

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

Parameters

list	The list of elements to remove. The list must not be null.

Implemented in DriveEngine::DefaultParameterList.

---

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

• Framework/Public/Collections/IList.h