DGtal::KhalimskyCell< dim, TInteger > Struct Template Reference

#include <KhalimskySpaceND.h>

Inheritance diagram for DGtal::KhalimskyCell< dim, TInteger >:

Collaboration diagram for DGtal::KhalimskyCell< dim, TInteger >:

Public Types
typedef TInteger	Integer
typedef NumberTraits< Integer > ::UnsignedVersion	UnsignedInteger
typedef PointVector< dim, Integer >	Point

Public Member Functions
	BOOST_CONCEPT_ASSERT ((CInteger< TInteger >))
	BOOST_CONCEPT_ASSERT ((CSignedInteger< TInteger >))
	KhalimskyCell ()
	KhalimskyCell (const KhalimskyCell &other)
	KhalimskyCell (const Point &point)
KhalimskyCell &	operator= (const KhalimskyCell &other)
bool	operator== (const KhalimskyCell &other) const
bool	operator!= (const KhalimskyCell &other) const
bool	operator< (const KhalimskyCell &other) const
std::string	className () const

Data Fields
Point	myCoordinates

---

Detailed Description

template<Dimension dim, typename TInteger = DGtal::int32_t>
struct DGtal::KhalimskyCell< dim, TInteger >

Represents an (unsigned) cell in a cellular grid space by its Khalimsky coordinates.

Definition at line 80 of file KhalimskySpaceND.h.

---

Member Typedef Documentation

template<Dimension dim, typename TInteger = DGtal::int32_t>

typedef TInteger DGtal::KhalimskyCell< dim, TInteger >::Integer

Definition at line 89 of file KhalimskySpaceND.h.

template<Dimension dim, typename TInteger = DGtal::int32_t>

typedef PointVector< dim, Integer > DGtal::KhalimskyCell< dim, TInteger >::Point

Definition at line 92 of file KhalimskySpaceND.h.

template<Dimension dim, typename TInteger = DGtal::int32_t>

typedef NumberTraits<Integer>::UnsignedVersion DGtal::KhalimskyCell< dim, TInteger >::UnsignedInteger

Definition at line 91 of file KhalimskySpaceND.h.

---

Constructor & Destructor Documentation

template<Dimension dim, typename TInteger >

DGtal::KhalimskyCell< dim, TInteger >::KhalimskyCell ( )

inline

Constructor.

Definition at line 66 of file KhalimskySpaceND.ih.

{
}

template<Dimension dim, typename TInteger >

DGtal::KhalimskyCell< dim, TInteger >::KhalimskyCell ( const KhalimskyCell< dim, TInteger > &  other )

inline

Copy constructor.

Parameters:

other

any other cell.

Definition at line 73 of file KhalimskySpaceND.ih.

  : myCoordinates( other.myCoordinates )
{
}

template<Dimension dim, typename TInteger >

DGtal::KhalimskyCell< dim, TInteger >::KhalimskyCell ( const Point &  point )

inline

constructor from point.

Parameters:

other

any point.

Definition at line 81 of file KhalimskySpaceND.ih.

  : myCoordinates( p )
{
}

---

Member Function Documentation

template<Dimension dim, typename TInteger = DGtal::int32_t>

DGtal::KhalimskyCell< dim, TInteger >::BOOST_CONCEPT_ASSERT

(

(CInteger< TInteger >)

)

template<Dimension dim, typename TInteger = DGtal::int32_t>

DGtal::KhalimskyCell< dim, TInteger >::BOOST_CONCEPT_ASSERT

(

(CSignedInteger< TInteger >)

)

template<Dimension dim, typename TInteger >

std::string DGtal::KhalimskyCell< dim, TInteger >::className ( ) const

inline

Default drawing style object.

Returns:

the dyn. alloc. default style for this object.

the style name used for drawing this object.

Definition at line 142 of file KhalimskySpaceND.ih.

Referenced by DGtal::Display3DFactory::draw().

{
  return "KhalimskyCell";
}

template<Dimension dim, typename TInteger >

bool DGtal::KhalimskyCell< dim, TInteger >::operator!= ( const KhalimskyCell< dim, TInteger > &  other ) const

inline

Difference operator.

Parameters:

other

any other cell.

Definition at line 110 of file KhalimskySpaceND.ih.

References DGtal::KhalimskyCell< dim, TInteger >::myCoordinates.

{
  return myCoordinates != other.myCoordinates;
}

template<Dimension dim, typename TInteger >

bool DGtal::KhalimskyCell< dim, TInteger >::operator< ( const KhalimskyCell< dim, TInteger > &  other ) const

inline

Inferior operator. (lexicographic order).

Parameters:

other

any other cell.

Definition at line 119 of file KhalimskySpaceND.ih.

References DGtal::KhalimskyCell< dim, TInteger >::myCoordinates.

{
  return myCoordinates < other.myCoordinates;
}

template<Dimension dim, typename TInteger >

DGtal::KhalimskyCell< dim, TInteger > & DGtal::KhalimskyCell< dim, TInteger >::operator= ( const KhalimskyCell< dim, TInteger > &  other )

inline

Copy constructor.

Parameters:

other

any other cell.

Definition at line 90 of file KhalimskySpaceND.ih.

References DGtal::KhalimskyCell< dim, TInteger >::myCoordinates.

{
  if ( this != &other )
    myCoordinates = other.myCoordinates;
  return *this;
}

template<Dimension dim, typename TInteger >

bool DGtal::KhalimskyCell< dim, TInteger >::operator== ( const KhalimskyCell< dim, TInteger > &  other ) const

inline

Equality operator.

Parameters:

other

any other cell.

Definition at line 101 of file KhalimskySpaceND.ih.

References DGtal::KhalimskyCell< dim, TInteger >::myCoordinates.

{
  return myCoordinates == other.myCoordinates;
}

---

Field Documentation

template<Dimension dim, typename TInteger = DGtal::int32_t>

Point DGtal::KhalimskyCell< dim, TInteger >::myCoordinates

Definition at line 94 of file KhalimskySpaceND.h.

Referenced by DGtal::Display3DFactory::draw(), DGtal::Display2DFactory::draw(), DGtal::KhalimskyCell< dim, TInteger >::operator!=(), DGtal::KhalimskyCell< dim, TInteger >::operator<(), DGtal::KhalimskyCell< dim, TInteger >::operator=(), DGtal::KhalimskyCell< dim, TInteger >::operator==(), DGtal::KhalimskySpaceND< dim, TInteger >::signs(), DGtal::KhalimskySpaceND< dim, TInteger >::uCell(), DGtal::KhalimskySpaceND< dim, TInteger >::uCoord(), DGtal::KhalimskySpaceND< dim, TInteger >::uCoords(), DGtal::KhalimskySpaceND< dim, TInteger >::uDim(), DGtal::KhalimskySpaceND< dim, TInteger >::uDistanceToMax(), DGtal::KhalimskySpaceND< dim, TInteger >::uDistanceToMin(), DGtal::KhalimskySpaceND< dim, TInteger >::uGetAdd(), DGtal::KhalimskySpaceND< dim, TInteger >::uGetDecr(), DGtal::KhalimskySpaceND< dim, TInteger >::uGetIncr(), DGtal::KhalimskySpaceND< dim, TInteger >::uGetSub(), DGtal::KhalimskySpaceND< dim, TInteger >::uIncident(), DGtal::KhalimskySpaceND< dim, TInteger >::uIsInside(), DGtal::KhalimskySpaceND< dim, TInteger >::uIsMax(), DGtal::KhalimskySpaceND< dim, TInteger >::uIsMin(), DGtal::KhalimskySpaceND< dim, TInteger >::uIsOpen(), DGtal::KhalimskySpaceND< dim, TInteger >::uKCoord(), DGtal::KhalimskySpaceND< dim, TInteger >::uKCoords(), DGtal::KhalimskySpaceND< dim, TInteger >::uNext(), DGtal::KhalimskySpaceND< dim, TInteger >::uPointel(), DGtal::KhalimskySpaceND< dim, TInteger >::uProject(), DGtal::KhalimskySpaceND< dim, TInteger >::uProjection(), DGtal::KhalimskySpaceND< dim, TInteger >::uSetCoord(), DGtal::KhalimskySpaceND< dim, TInteger >::uSetCoords(), DGtal::KhalimskySpaceND< dim, TInteger >::uSetKCoord(), DGtal::KhalimskySpaceND< dim, TInteger >::uSetKCoords(), DGtal::KhalimskySpaceND< dim, TInteger >::uSpel(), DGtal::KhalimskySpaceND< dim, TInteger >::uTopology(), and DGtal::KhalimskySpaceND< dim, TInteger >::uTranslation().

---

The documentation for this struct was generated from the following files:

• KhalimskySpaceND.h
• KhalimskySpaceND.ih