Interface of list of 2D position for a specific image. More...

#include <IPosition2DList.h>

Inheritance diagram for DriveEngine::IPosition2DList:

Public Member Functions
virtual const IImage *	GetSourceImage () const =0
	Gets the source image, if any. More...

virtual void	SetSourceImage (const IImage &image)=0
	Sets the source image More...

virtual IPosition2D *	GetIPosition2D (Index index) const =0
	Gets the 2D position. More...

virtual void	Add (IPosition2D &position)=0
	Adds a 2D position. More...

virtual void	Remove (IPosition2D &position)=0
	Removes a 2D position, if it exist in the list. Otherwise, do nothing. More...

Public Member Functions inherited from DriveEngine::IList
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

Interface of list of 2D position for a specific image.

Contain a reference to the source image.

Member Function Documentation

virtual void DriveEngine::IPosition2DList::Add ( IPosition2D & position )

pure virtual

Adds a 2D position.

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

Parameters

position The 2D position to add. The position must not be null.

virtual IPosition2D* DriveEngine::IPosition2DList::GetIPosition2D ( Index index ) const

pure virtual

Gets the 2D position.

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

Parameters

index The index. It must be positive and must not exceed the size of the list.

Returns: The 2D position. On error, returns nullptr.

virtual const IImage* DriveEngine::IPosition2DList::GetSourceImage ( ) const

pure virtual

Gets the source image, if any.

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

Returns: The source image, if any. Otherwise, returns nullptr.

Implemented in DriveEngine::DefaultPosition2DList.

virtual void DriveEngine::IPosition2DList::Remove ( IPosition2D & position )

pure virtual

Removes a 2D position, if it exist in the list. Otherwise, do nothing.

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

Parameters

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

virtual void DriveEngine::IPosition2DList::SetSourceImage ( const IImage & image )

pure virtual

Sets the source image

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

Parameters

image The image. It must not be null.

Implemented in DriveEngine::DefaultPosition2DList.

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

Framework/Public/Collections/IPosition2DList.h

Public Member Functions

Detailed Description

Member Function Documentation