The Cursor is used to traverse through a given data source within the database. More...

Public Member Functions
	Cursor (IXImageDatabaseBase db, DataTransformer< T > transformer, string strSrc, Log log=null)
	The Cursor constructor. More...

void	Reset ()
	Resets the current index bact to the start. More...

void	Next ()
	Traverses to the next item within the data source. More...

void	SeekToFirst ()
	Move the cursor to the beginning of the data source. More...

SimpleDatum	GetValue (int? nLabel=null, bool bLoadDataCriteria=false, DB_ITEM_SELECTION_METHOD? imgSel=null)
	Retrieve the Datum at the current cursor location within the data source. More...

Properties
int	Count `[get]`
	Returns the number of items traversed. More...

bool	IsValid `[get]`
	Queryies to see if we are still within the bounds of the data source, if so true is returned, otherwise if the Cursor it as the end of the data source, false is returned. More...

Detailed Description

The Cursor is used to traverse through a given data source within the database.

Definition at line 62 of file DB.cs.

Constructor & Destructor Documentation

◆ Cursor()

MyCaffe.data.Cursor< T >.Cursor	(	IXImageDatabaseBase	db,
		DataTransformer< T >	transformer,
		string	strSrc,
		Log	log = `null`
	)

The Cursor constructor.

Parameters

db	Specifies the underlying database.
transformer	Specifies the data transformer used to transform the lables (when active).
strSrc	Specifies the name of the data source to use.
log	Optionally, specifies an output log used for diagnostic information if specified (default = null).

Definition at line 79 of file DB.cs.

Member Function Documentation

◆ GetValue()

SimpleDatum MyCaffe.data.Cursor< T >.GetValue	(	int?	nLabel = `null`,
		bool	bLoadDataCriteria = `false`,
		DB_ITEM_SELECTION_METHOD?	imgSel = `null`
	)

Retrieve the Datum at the current cursor location within the data source.

Parameters

nLabel	Optionally, specifies a label for which the cursor should query from.
bLoadDataCriteria	Specifies whether or not to load the data criteria.
imgSel	Optionally, specifies the image selection method (default = null).

Returns: The Datum retrieved is returned.

Definition at line 144 of file DB.cs.

◆ Next()

void MyCaffe.data.Cursor< T >.Next ( )

Traverses to the next item within the data source.

Definition at line 101 of file DB.cs.

◆ Reset()

void MyCaffe.data.Cursor< T >.Reset ( )

Resets the current index bact to the start.

Definition at line 93 of file DB.cs.

◆ SeekToFirst()

void MyCaffe.data.Cursor< T >.SeekToFirst ( )

Move the cursor to the beginning of the data source.

Definition at line 132 of file DB.cs.

Property Documentation

◆ Count

int MyCaffe.data.Cursor< T >.Count

get

Returns the number of items traversed.

Definition at line 109 of file DB.cs.

◆ IsValid

bool MyCaffe.data.Cursor< T >.IsValid

get

Queryies to see if we are still within the bounds of the data source, if so true is returned, otherwise if the Cursor it as the end of the data source, false is returned.

Definition at line 118 of file DB.cs.

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

C:/Data/Data/SS_Projects/Intelligence/GitHub/MyCaffe/MyCaffe/data/DB.cs

Public Member Functions

Properties