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

- Public Types inherited from carto::rc_ptr< StructuringElement >
typedef StructuringElement referenced_type
- Public Types inherited from carto::const_ref< T >
typedef T referenced_type

Public Member Functions

 StructuringElementRef ()
 Default constructor. More...
 StructuringElementRef (StructuringElement *se)
 New object constructor. More...
 StructuringElementRef (const carto::rc_ptr< StructuringElement > &se)
 Copy constructor. More...
iterator begin ()
iterator end ()
const_iterator begin () const
const_iterator end () const
size_t size () const
const std::vector< Point3d > & getVector () const
std::vector< int > getAmplitude (const Point3d &origin=Point3d(0, 0, 0)) const
- Public Member Functions inherited from carto::rc_ptr< StructuringElement >
 rc_ptr ()
 rc_ptr (StructuringElement *p)
 rc_ptr (StructuringElement *p, bool externalowner)
void reset (StructuringElement *p=NULL)
StructuringElement * get () const
bool operator< (const rc_ptr< StructuringElement > &other) const
 operator insipid * () const
 ref ()
 ref (StructuringElement *pObject)
 ref (StructuringElement *pObject, bool externalowner)
 ref (const ref< StructuringElement > &other)
 ref (const ref< R > &other)
 ~ref ()
StructuringElement * release ()
ref< StructuringElement > & operator= (const ref< StructuringElement > &other)
StructuringElement * operator-> () const
StructuringElement & operator* () const
StructuringElement * 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 (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
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

Constructor & Destructor Documentation

aims::StructuringElementRef::StructuringElementRef ( )

Default constructor.

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

Definition at line 224 of file structuring_element.h.

aims::StructuringElementRef::StructuringElementRef ( StructuringElement se)

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.

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

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.

Member Function Documentation

iterator aims::StructuringElementRef::begin ( )

Definition at line 239 of file structuring_element.h.

const_iterator aims::StructuringElementRef::begin ( ) const

Definition at line 241 of file structuring_element.h.

iterator aims::StructuringElementRef::end ( )

Definition at line 240 of file structuring_element.h.

const_iterator aims::StructuringElementRef::end ( ) const

Definition at line 242 of file structuring_element.h.

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

Definition at line 248 of file structuring_element.h.

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

Definition at line 245 of file structuring_element.h.

size_t aims::StructuringElementRef::size ( ) const

Definition at line 244 of file structuring_element.h.

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