A.I.M.S


AimsBucketItem< T > Class Template Reference

The template base class for all types of bucket items. More...

#include <aims/bucket/item.h>

Collaboration diagram for AimsBucketItem< T >:

Public Member Functions

Constructors and destructor
 AimsBucketItem ()
 Constructor sets location to origin (0,0,0) More...
 
 AimsBucketItem (const AimsBucketItem< T > &other)
 Copy constructor. More...
 
 ~AimsBucketItem ()
 Destructor does nothing. More...
 
Location and Value manipulation methods, references
const T & value () const
 Get a const reference to the value of the bucket item. More...
 
T & value ()
 Get a non-const reference to the value of the bucket item. More...
 
const AimsVector< short, 3 > & location () const
 Get a const reference to the location of the bucket item. More...
 
AimsVector< short, 3 > & location ()
 Get a non-const reference to the location of the bucket item. More...
 

Protected Attributes

Data
AimsVector< short, 3 > _location
 Location of the item in the 3D image. More...
 
_value
 Value associated to the location. More...
 

Friends

int operator== (const AimsBucketItem< T > &thing1, const AimsBucketItem< T > &thing2)
 
std::ostream & operator<< (std::ostream &out, const AimsBucketItem< T > &thing)
 

Detailed Description

template<class T>
class AimsBucketItem< T >

The template base class for all types of bucket items.

The template argument gives the type of the value associated to a location. It can be a scalar, but also a more complex data.

Definition at line 47 of file item.h.

Constructor & Destructor Documentation

template<class T>
AimsBucketItem< T >::AimsBucketItem ( )
inline

Constructor sets location to origin (0,0,0)

Definition at line 76 of file item.h.

template<class T>
AimsBucketItem< T >::AimsBucketItem ( const AimsBucketItem< T > &  other)
inline

Copy constructor.

Definition at line 78 of file item.h.

template<class T>
AimsBucketItem< T >::~AimsBucketItem ( )
inline

Destructor does nothing.

Definition at line 81 of file item.h.

Member Function Documentation

template<class T>
AimsVector<short,3>& AimsBucketItem< T >::location ( )
inline

Get a non-const reference to the location of the bucket item.

Definition at line 94 of file item.h.

template<class T>
T& AimsBucketItem< T >::value ( )
inline

Get a non-const reference to the value of the bucket item.

Definition at line 89 of file item.h.

Friends And Related Function Documentation

template<class T>
std::ostream& operator<< ( std::ostream &  out,
const AimsBucketItem< T > &  thing 
)
friend

Definition at line 118 of file item.h.

template<class T>
int operator== ( const AimsBucketItem< T > &  thing1,
const AimsBucketItem< T > &  thing2 
)
friend

Definition at line 110 of file item.h.

Member Data Documentation

template<class T>
AimsVector<short,3> AimsBucketItem< T >::_location
protected

Location of the item in the 3D image.

Definition at line 67 of file item.h.

template<class T>
T AimsBucketItem< T >::_value
protected

Value associated to the location.

Definition at line 69 of file item.h.


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