aims::StructuringElementRef Class Reference

Convenient handle for a StructuringElement. More...

#include <aims/connectivity/structuring_element.h>

Inheritance diagram for aims::StructuringElementRef:

Collaboration diagram for aims::StructuringElementRef:

Public Types
typedef StructuringElement::iterator	iterator
typedef StructuringElement::const_iterator	const_iterator
Public Types inherited from carto::ref< T >
typedef T	referenced_type
Public Types inherited from carto::const_ref< T >
typedef T	referenced_type

Public Member Functions
	StructuringElementRef ()
	Default constructor.
	StructuringElementRef (StructuringElement *se)
	New object constructor.
	StructuringElementRef (const carto::rc_ptr< StructuringElement > &se)
	Copy constructor.
iterator	begin ()
iterator	end ()
const_iterator	begin () const
const_iterator	end () const
size_t	size () const
const std::vector< Point3dl > &	getVector () const
std::vector< int >	getAmplitude (const Point3dl &origin=Point3dl(0, 0, 0)) const
Public Member Functions inherited from carto::rc_ptr< StructuringElement >
	rc_ptr ()
	rc_ptr (T *p)
	rc_ptr (T *p, bool externalowner)
	rc_ptr (std::auto_ptr< U > r)
void	reset (T *p=NULL)
T *	get () const
bool	operator< (const rc_ptr< T > &other) const
	operator insipid * () const
Public Member Functions inherited from carto::ref< T >
	ref ()
	ref (T *pObject)
	ref (T *pObject, bool externalowner)
	ref (std::auto_ptr< U > r)
	ref (const ref< T > &other)
	ref (const ref< R > &other)
	~ref ()
T *	release ()
ref< T > &	operator= (const ref< T > &other)
T *	operator-> () const
T &	operator* () const
T *	pointer () const
Public Member Functions inherited from carto::const_ref< T >
	const_ref ()
	const_ref (const T *pObject)
	const_ref (const T *pObject, bool externalowner)
	const_ref (std::auto_ptr< U > r)
	const_ref (const ref< T > &other)
	const_ref (const const_ref< T > &other)
	const_ref (const ref< R > &o)
	const_ref (const const_ref< R > &other)
	~const_ref ()
const_ref< T > &	operator= (const ref< T > &other)
const_ref< T > &	operator= (const const_ref< T > &other)
bool	isNull () const
bool	operator== (const ref< T > &other) const
bool	operator== (const T *pointer) const
bool	operator== (const const_ref< T > &other) const
bool	operator!= (const ref< T > &other) const
bool	operator!= (const const_ref< T > &other) const
bool	operator!= (const T *pointer) const
const T *	operator-> () const
const T &	operator* () const
const T *	pointer () const
int	refCount () const
Public Member Functions inherited from carto::RefData< T >
int	count () const

Detailed Description

Convenient handle for a StructuringElement.

This class is a reference counting pointer to a StructuringElement (or one of its derived classes). It also implements all StructuringElement public methods.

Definition at line 214 of file structuring_element.h.

Member Typedef Documentation

const_iterator

typedef StructuringElement::const_iterator aims::StructuringElementRef::const_iterator

Definition at line 218 of file structuring_element.h.

iterator

typedef StructuringElement::iterator aims::StructuringElementRef::iterator

Definition at line 217 of file structuring_element.h.

Constructor & Destructor Documentation

StructuringElementRef() [1/3]

aims::StructuringElementRef::StructuringElementRef ( )

inline

Default constructor.

This constructor builds an empty pointer. Such a pointer equals to strel::none().

Definition at line 224 of file structuring_element.h.

References carto::rc_ptr< StructuringElement >::rc_ptr().

StructuringElementRef() [2/3]

aims::StructuringElementRef::StructuringElementRef ( StructuringElement * se )

inline

New object constructor.

This constructor initiate reference counting. It should always be passed an unowned pointer (for example, built using new)

Definition at line 230 of file structuring_element.h.

References carto::rc_ptr< StructuringElement >::rc_ptr().

StructuringElementRef() [3/3]

aims::StructuringElementRef::StructuringElementRef ( const carto::rc_ptr< StructuringElement > & se )

inline

Copy constructor.

This constructor takes any reference counted pointer. It increments the reference counter by one.

Definition at line 236 of file structuring_element.h.

References carto::rc_ptr< StructuringElement >::rc_ptr().

Member Function Documentation

begin() [1/2]

iterator aims::StructuringElementRef::begin ( )

inline

Definition at line 239 of file structuring_element.h.

begin() [2/2]

const_iterator aims::StructuringElementRef::begin ( ) const

inline

Definition at line 241 of file structuring_element.h.

end() [1/2]

iterator aims::StructuringElementRef::end ( )

inline

Definition at line 240 of file structuring_element.h.

end() [2/2]

const_iterator aims::StructuringElementRef::end ( ) const

inline

Definition at line 242 of file structuring_element.h.

getAmplitude()

std::vector< int > aims::StructuringElementRef::getAmplitude ( const Point3dl & origin = Point3dl(0,0,0) ) const

inline

Definition at line 248 of file structuring_element.h.

getVector()

const std::vector< Point3dl > & aims::StructuringElementRef::getVector ( ) const

inline

Definition at line 245 of file structuring_element.h.

size()

size_t aims::StructuringElementRef::size ( ) const

inline

Definition at line 244 of file structuring_element.h.

---

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

• aims/connectivity/structuring_element.h