Clipper
Public Member Functions | List of all members
clipper::NXmap_base::Map_reference_index Class Reference

Map reference with index-like behaviour. More...

#include <nxmap.h>

Inheritance diagram for clipper::NXmap_base::Map_reference_index:
clipper::NXmap_base::Map_reference_base

Public Member Functions

 Map_reference_index ()
 Null constructor.
 
 Map_reference_index (const NXmap_base &map)
 Constructor: need parent map.
 
 Map_reference_index (const NXmap_base &map, const Coord_grid &pos)
 Constructor: need parent map and coord.
 
Coord_grid coord () const
 Get current grid coordinate.
 
const Coord_orth coord_orth () const
 Get current value of orthogonal coordinate.
 
Map_reference_indexset_coord (const Coord_grid &pos)
 Set current value of coordinate - optimised for nearby coords.
 
Map_reference_indexnext ()
 Simple increment.
 
int index_offset (const int &du, const int &dv, const int &dw) const
 Index of neighbouring point.
 
const NXmap_basebase_nxmap () const
 
const int & index () const
 
bool last () const
 
- Public Member Functions inherited from clipper::NXmap_base::Map_reference_base
const NXmap_basebase_nxmap () const
 return the parent NXmap
 
const int & index () const
 Get the index into the map data array.
 
bool last () const
 Check for end of map.
 

Additional Inherited Members

- Protected Attributes inherited from clipper::NXmap_base::Map_reference_base
const NXmap_basemap_
 pointer to map for which this Map_reference_index is defined
 
int index_
 integer index into map data array
 

Detailed Description

Map reference with index-like behaviour.

This is a reference to a map coordinate. It behaves like a simple index into the map, but can be easily converted into a coordinate as and when required. It also implements methods for iterating through the map. It is very compact, but coord() involves some overhead.

Note
The following methods are inherited from Map_reference_base but are documented here for convenience: base_nxmap(), index(), last().

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