cm::SCMCell< IDType > Class Template Reference

Template class for Cells used with Simple Cell Mapping. More...

#include <cell.h>

Inheritance diagram for cm::SCMCell< IDType >:

Public Member Functions
	SCMCell ()
	Step number of this cell (0 for periodic cells, positive for transient cells) More...
IDType	getImage () const
	Returns the image of the cell. More...
void	setImage (IDType image)
	Sets the image of the cell. More...
IDType	getGroup () const
	Returns the group number of the cell. More...
void	setGroup (IDType group)
	Sets the group number of the cell. More...
IDType	getStep () const
	Returns the step number of the cell. More...
void	setStep (IDType step)
	Sets the step number of the cell. More...
Public Member Functions inherited from cm::CellBase
	CellBase ()
	The state of the cell. More...
CellState	getState () const
	Returns the state of the cell. More...
void	setState (CellState state)
	Sets the state of the cell. More...

Detailed Description

template<class IDType>
class cm::SCMCell< IDType >

Template class for Cells used with Simple Cell Mapping.

If ID_type is uint32_t, max number of cells is: ~4294 million sizeof(SCMCell) is: 4*4 = 16 bytes (due to padding) max usable memory: ~68.7 Gigabytes If you have more memory, use uint64_t as IDType.

Constructor & Destructor Documentation

SCMCell()

template<class IDType >

cm::SCMCell< IDType >::SCMCell ( )

inline

Step number of this cell (0 for periodic cells, positive for transient cells)

Member Function Documentation

getGroup()

template<class IDType >

IDType cm::SCMCell< IDType >::getGroup ( ) const

inline

Returns the group number of the cell.

getImage()

template<class IDType >

IDType cm::SCMCell< IDType >::getImage ( ) const

inline

Returns the image of the cell.

getStep()

template<class IDType >

IDType cm::SCMCell< IDType >::getStep ( ) const

inline

Returns the step number of the cell.

setGroup()

template<class IDType >

void cm::SCMCell< IDType >::setGroup ( IDType  group )

inline

Sets the group number of the cell.

setImage()

template<class IDType >

void cm::SCMCell< IDType >::setImage ( IDType  image )

inline

Sets the image of the cell.

setStep()

template<class IDType >

void cm::SCMCell< IDType >::setStep ( IDType  step )

inline

Sets the step number of the cell.

---

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

• C:/Work/git/cell-mapping/cpp/cm/cell.h