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)
	AimsBucketItem (const AimsBucketItem< T > &other)
	Copy constructor.
	~AimsBucketItem ()
	Destructor does nothing.

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

Location and Value manipulation methods, references
const T &	value () const
	Get a const reference to the value of the bucket item.
T &	value ()
	Get a non-const reference to the value of the bucket item.
const AimsVector< short, 3 > &	location () const
	Get a const reference to the location of the bucket item.
AimsVector< short, 3 > &	location ()
	Get a non-const reference to the location of the bucket item.
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 62 of file item.h.

Constructor & Destructor Documentation

AimsBucketItem() [1/2]

template<class T>

AimsBucketItem< T >::AimsBucketItem ( )

inline

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

Definition at line 76 of file item.h.

References _location.

Referenced by AimsBucketItem(), operator<<, and operator==.

AimsBucketItem() [2/2]

template<class T>

AimsBucketItem< T >::AimsBucketItem ( const AimsBucketItem< T > & other )

inline

Copy constructor.

Definition at line 78 of file item.h.

References _location, _value, and AimsBucketItem().

~AimsBucketItem()

template<class T>

AimsBucketItem< T >::~AimsBucketItem ( )

inline

Destructor does nothing.

Definition at line 81 of file item.h.

Member Function Documentation

location() [1/2]

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.

References _location.

location() [2/2]

template<class T>

const AimsVector< short, 3 > & AimsBucketItem< T >::location ( ) const

inline

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

Definition at line 92 of file item.h.

References _location.

Referenced by aims::AimsConnectedComponent(), aims::AimsConnectedComponent(), aims::AimsLabeledConnectedComponent(), operator<<, AimsBucket< T >::operator=(), operator==, aims::DefaultAsciiItemReader< AimsBucketItem< T > >::read(), aims::DefaultBSwapItemReader< AimsBucketItem< T > >::read(), aims::DefaultItemReader< AimsBucketItem< T > >::read(), aims::DefaultAsciiItemWriter< AimsBucketItem< T > >::write(), aims::DefaultBSwapItemWriter< AimsBucketItem< T > >::write(), and aims::DefaultItemWriter< AimsBucketItem< T > >::write().

value() [1/2]

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.

References _value.

value() [2/2]

template<class T>

const T & AimsBucketItem< T >::value ( ) const

inline

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

Definition at line 87 of file item.h.

References _value.

Referenced by operator<<, AimsBucket< T >::operator=(), operator==, aims::DefaultAsciiItemReader< AimsBucketItem< T > >::read(), aims::DefaultBSwapItemReader< AimsBucketItem< T > >::read(), aims::DefaultItemReader< AimsBucketItem< T > >::read(), aims::DefaultAsciiItemWriter< AimsBucketItem< T > >::write(), aims::DefaultBSwapItemWriter< AimsBucketItem< T > >::write(), and aims::DefaultItemWriter< AimsBucketItem< T > >::write().

Friends And Related Symbol Documentation

operator<<

template<class T>

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

friend

Definition at line 118 of file item.h.

References AimsBucketItem(), location(), and value().

operator==

template<class T>

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

friend

Definition at line 110 of file item.h.

References AimsBucketItem(), location(), and value().

Member Data Documentation

_location

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.

Referenced by AimsBucketItem(), AimsBucketItem(), location(), and location().

_value

template<class T>

T AimsBucketItem< T >::_value

protected

Value associated to the location.

Definition at line 69 of file item.h.

Referenced by AimsBucketItem(), value(), and value().

---

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

• aims/bucket/item.h