RecoIndex Class Reference

#include <index.h>

Public Types
enum	indexMode
enum	printMode

Public Member Functions
	RecoIndex (unsigned short v=0)
RecoIndex &	operator= (unsigned short v)
bool	operator< (const RecoIndex &ri) const
	operator unsigned short () const
RecoIndex &	set_mode (indexMode m)
indexMode	get_mode () const
bool	compatible (const RecoIndex &ri) const
bool	prep_count (const RecoIndex &mask)
RecoIndex &	set_numof (unsigned short n)
unsigned short	get_numof () const
STD_string	print (recoDim dim, printMode printmode=brief) const

Detailed Description

Manages information of data in one dimension.

Definition at line 35 of file index.h.

Member Enumeration Documentation

indexMode

enum RecoIndex::indexMode

Mode the index is used for:

• separate : Dimensions are processed separately.
• ignore : Same as 'separate', but the index is ignored when comparing indices.
• single : In a previous processing step, a single index was selected (or reduction to a single index), as an effect, this index is always zero. (Since only one value is possible, it is ignored when sorting indices (operator <))
• collected : Data from all inidices is combined and transfered simultaneously.
• any : Any of the above (for checking functor interfaces).

Definition at line 48 of file index.h.

printMode

enum RecoIndex::printMode

Mode for printing the index:

• brief : Brief version for debugging
• all : Include all information, i.e. all indices will be printed with their current value, regardless of their mode or numof
• filename : Suitable for generating filenames

Definition at line 128 of file index.h.

Constructor & Destructor Documentation

RecoIndex()

RecoIndex::RecoIndex ( unsigned short  v = 0 )

inline

Constructs default index object.

Definition at line 54 of file index.h.

Member Function Documentation

compatible()

bool RecoIndex::compatible ( const RecoIndex &  ri ) const

inline

Returns true if two indices are compatible when chaining functors

Definition at line 90 of file index.h.

get_mode()

indexMode RecoIndex::get_mode ( ) const

inline

Returns the mode

Definition at line 85 of file index.h.

get_numof()

unsigned short RecoIndex::get_numof ( ) const

inline

Returns the number of indices

Definition at line 119 of file index.h.

operator unsigned short()

RecoIndex::operator unsigned short ( ) const

inline

Conversion operator

Definition at line 75 of file index.h.

operator<()

bool RecoIndex::operator< ( const RecoIndex &  ri ) const

inline

Comparison operator for indexing

Definition at line 64 of file index.h.

operator=()

RecoIndex& RecoIndex::operator= ( unsigned short  v )

inline

Assignment operator from integer.

Definition at line 59 of file index.h.

prep_count()

bool RecoIndex::prep_count ( const RecoIndex &  mask )

inline

Returns true if this is in the range of 'mask'. Prepares index for count map.

Definition at line 102 of file index.h.

print()

STD_string RecoIndex::print	(	recoDim	dim,
		printMode	printmode = brief
	)		const

Converts the index to a string for reco dimension 'dim' according to 'printmode'

set_mode()

RecoIndex& RecoIndex::set_mode ( indexMode  m )

inline

Sets the mode

Definition at line 80 of file index.h.

set_numof()

RecoIndex& RecoIndex::set_numof ( unsigned short  n )

inline

Sets the number of indices

Definition at line 114 of file index.h.

---

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

• index.h