$extrastylesheet
Olena  User documentation 2.1
An Image Processing Platform
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
mln::complex_psite< D, G > Class Template Reference

#include <mln/core/site_set/complex_psite.hh>

Public Member Functions

bool has_target () const
const siteto_site () const
 complex_psite ()
 complex_psite (const p_complex< D, G > &pc, const topo::face< D > &face)
 complex_psite (const p_complex< D, G > &pc, unsigned n, unsigned face_id)
bool is_valid () const
void invalidate ()
const targetsite_set () const
const targettarget_ () const
void change_target (const target &new_target)
const G::site & subj_ ()
const topo::face< D > & face () const
unsigned n () const
unsigned face_id () const

Public Types

typedef Pseudo_Site< void > category
typedef complex_psite< D, G > exact_t
typedef mln::metal::unqualif
< q_site_ >::ret 
site
typedef p_complex< D, G > target
typedef p_complex< D, G > target_t

Related Functions

(Note that these are not member functions.)

template<unsigned D, typename G >
std::ostream & operator<< (std::ostream &ostr, const complex_psite< D, G > &p)
template<unsigned D, typename G >
bool operator== (const complex_psite< D, G > &lhs, const complex_psite< D, G > &rhs)
template<unsigned D, typename G >
bool operator< (const complex_psite< D, G > &lhs, const complex_psite< D, G > &rhs)

Detailed Description

template<unsigned D, typename G>
class mln::complex_psite< D, G >

Point site associated to a mln::p_complex.

Template Parameters
DThe dimension of the complex this psite belongs to.
GThe geometry of the complex.

Definition at line 61 of file complex_psite.hh.

Constructor & Destructor Documentation

template<unsigned D, typename G>
mln::complex_psite< D, G >::complex_psite ( )

Construction and assignment.

template<unsigned D, typename G>
mln::complex_psite< D, G >::complex_psite ( const p_complex< D, G > &  pc,
const topo::face< D > &  face 
)
Precondition
pc.cplx() == face.cplx().
template<unsigned D, typename G>
mln::complex_psite< D, G >::complex_psite ( const p_complex< D, G > &  pc,
unsigned  n,
unsigned  face_id 
)

Member Function Documentation

template<unsigned D, typename G>
void mln::complex_psite< D, G >::change_target ( const target new_target)

Set the target site_set.

template<unsigned D, typename G>
const topo::face<D>& mln::complex_psite< D, G >::face ( ) const

Face handle manipulators.

Return the face handle of this point site.

template<unsigned D, typename G>
unsigned mln::complex_psite< D, G >::face_id ( ) const

Return the id of the face of this psite.

bool mln::Pseudo_Site< complex_psite< D, G > >::has_target ( ) const
inherited
template<unsigned D, typename G>
void mln::complex_psite< D, G >::invalidate ( )

Invalidate this psite.

template<unsigned D, typename G>
bool mln::complex_psite< D, G >::is_valid ( ) const

Psite manipulators.

Is this psite valid?

template<unsigned D, typename G>
unsigned mln::complex_psite< D, G >::n ( ) const

Return the dimension of the face of this psite.

template<unsigned D, typename G>
const target& mln::complex_psite< D, G >::site_set ( ) const

Site set manipulators.

Return the mln::p_complex this site is built on. (shortcut for *target()).

Precondition
Member face_ is valid.
template<unsigned D, typename G>
const G ::site& mln::complex_psite< D, G >::subj_ ( )

INTERNAL_API Proxy manipulators.

Return the site corresponding to this psite.

template<unsigned D, typename G>
const target* mln::complex_psite< D, G >::target_ ( ) const

INTERNAL_API Get a pointer to the target site_set.

const site& mln::internal::pseudo_site_base_< const G::site & , complex_psite< D, G > >::to_site ( ) const
inherited

Friends And Related Function Documentation

template<unsigned D, typename G >
bool operator< ( const complex_psite< D, G > &  lhs,
const complex_psite< D, G > &  rhs 
)
related

Is lhs ``less'' than rhs?

This comparison is required by algorithms sorting psites.

Precondition
Arguments lhs and rhs must belong to the same mln::p_complex. <D,G>
template<unsigned D, typename G >
std::ostream & operator<< ( std::ostream &  ostr,
const complex_psite< D, G > &  p 
)
related

<D,G>

template<unsigned D, typename G >
bool operator== ( const complex_psite< D, G > &  lhs,
const complex_psite< D, G > &  rhs 
)
related

Comparison of two instances of mln::complex_psite.

Is lhs equal to rhs?

Precondition
Arguments lhs and rhs must belong to the same mln::p_complex. <D,G>

Member Typedef Documentation

typedef Pseudo_Site<void> mln::Pseudo_Site< complex_psite< D, G > >::category
inherited

Definition at line 69 of file pseudo_site.hh.

typedef complex_psite< D, G > mln::Object< complex_psite< D, G > >::exact_t
inherited

Definition at line 105 of file object.hh.

typedef mln::metal::unqualif< q_site_ >::ret mln::internal::pseudo_site_base_< const G::site & , complex_psite< D, G > >::site
inherited

Definition at line 59 of file pseudo_site_base.hh.

template<unsigned D, typename G>
typedef p_complex<D, G> mln::complex_psite< D, G >::target

Definition at line 67 of file complex_psite.hh.

template<unsigned D, typename G>
typedef p_complex<D, G> mln::complex_psite< D, G >::target_t

Definition at line 69 of file complex_psite.hh.