Public Member Functions
clipper::HKL_info::HKL_reference_index Class Reference

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

#include <hkl_info.h>

Inheritance diagram for clipper::HKL_info::HKL_reference_index:

List of all members.

Public Member Functions

 HKL_reference_index ()
 Null constructor.
 HKL_reference_index (const HKL_info &hklinfo_, const int &index)
 Constructor: takes parent HKL_info and initial index.
const HKLhkl () const
 return the current HKL
const HKL_classhkl_class () const
 return the reflection class for the reflection
HKL_reference_indexnext ()
 increment to next reflection
const HKL_infobase_hkl_info () const
 return the parent HKL_info
const int & index () const
 return the current index (-1 if invalid)
const ftype invresolsq () const
 return the inv resol sq for the reflection (assumes index valid)
bool last () const
 test if index has gone past last reflection

Detailed Description

HKL reference with index-like behaviour.

This is a reference to an HKL. It behaves like a simple index into the reflection list, but can be easily converted into an HKL as and when required. It also implements methods for iterating through a reflection list.

The following methods are inherited from HKL_reference_base but are documented here for convenience: base_hkl_info(), index(), invresolsq(), last().

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