scala::BatchSelection Class Reference

A selection of batches, ie a collection of batch ranges & a batch list. More...

#include <hkl_datatypes.hh>

List of all members.

Public Member Functions
void	clear ()
	clear list
bool	Null () const
	return true if no entries
void	AddBatch (const int &batch, const int &fileSeriesList)
	Add in one batch to selection, qualified by fileSeriesList.
void	AddRange (const int &batch1, const int &batch2, const int &fileSeriesList, const int &flag=-1)
	Add in batch range to selection, qualified by fileSeriesList.
int	FindInSelection (const int &batch, const int &fileSeriesTest) const
	Return index in list if in selection, for given file series, else -1.
bool	InSelection (const int &batch, const int &fileSeriesTest) const
	Return true if in selection, for given file series.
int	FlagNumber (const int &batch)
	return numerical flag for batch, = -1 if not in list
std::vector< int >	UniqueFlags () const
	return list of unique numerical flags specified
std::vector< IntRange >	BatchRanges (const int &flag)
	return list of batch ranges for specified flag, all ranges if flag < 0
void	CheckSeries (const int &NumFileSeries) const
	Check that fileSeries specified on selection commands match specified files. Fail here if not.

---

Detailed Description

A selection of batches, ie a collection of batch ranges & a batch list.

Batches selections may be flagged with a "file series number": if this is > 0, then the numbers apply to the original numbers in the file, before any offsets. If == 0 then it applies to the offset numbers. They may also be flagged with an numerical flag eg a run number indicating what "class" they belong to, > 0 if valid, = 0 if unset

---

Member Function Documentation

void scala::BatchSelection::AddBatch	(	const int &	batch,
		const int &	fileSeriesList
	)

Add in one batch to selection, qualified by fileSeriesList.

fileSeriesList = 0 means final batch numbering (after any renumbering for file series > 1)

void scala::BatchSelection::AddRange	(	const int &	batch1,
		const int &	batch2,
		const int &	fileSeriesList,
		const int &	flag = -1
	)

Add in batch range to selection, qualified by fileSeriesList.

fileSeriesList = 0 to mean final batch numbering (after any renumbering for file series > 1)

bool scala::BatchSelection::InSelection	(	const int &	batch,
		const int &	fileSeriesTest
	)			const

Return true if in selection, for given file series.

Two possibilities for selection: 1) Specified selection on final numbering, ie from sole file or after renumbering of 2nd or subsequent file, fileSeriesList == 0, only test if fileSeriesTest == 0

---

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

• hkl_datatypes.hh
• hkl_datatypes.cpp