Public Member Functions | List of all members
SampleCollection< TData > Class Template Referenceabstract

Collection of data samples. More...

#include <cvb/sample_database/sample_list.hpp>

Public Member Functions

int Count () const
 Get the number of samples for this collection. More...
 
TData ReadData (int index) const
 Access one of the sample images. More...
 
TData RemoveAt (int index)
 Remove a sample. More...
 

Detailed Description

template<class TData>
class Cvb::SampleDatabase::SampleCollection< TData >

Collection of data samples.

Member Function Documentation

◆ Count()

int Count ( ) const
inline

Get the number of samples for this collection.

Returns
Number of elements in the collection.
Exceptions
Anyexception derived from std::exception including CvbException.

◆ ReadData()

TData ReadData ( int  index) const
inline

Access one of the sample images.

Parameters
[in]indexIndex to be accessed.
Returns
Sample data.
Exceptions
Anyexception derived from std::exception including CvbException.

◆ RemoveAt()

TData RemoveAt ( int  index)
inline

Remove a sample.

Parameters
[in]indexIndex of the sample to be removed.
Returns
The removed data object.
Exceptions
Anyexception derived from std::exception including CvbException.