Clipper
Public Member Functions
clipper::CHKL_data< T > Class Template Reference

Reflection data list container. More...

#include <container_hkl.h>

Inheritance diagram for clipper::CHKL_data< T >:
clipper::Container clipper::HKL_data< T > clipper::HKL_data_base

List of all members.

Public Member Functions

 CHKL_data ()
 null constructor
 CHKL_data (Container &parent, const String name="")
 constructor: inherit datalist and cell
void init (const HKL_info &hkl_info, const Cell &cell)
 initialiser: supply or inherit hkl list, and cell
void init (const Spacegroup &spacegroup, const Cell &cell, const HKL_sampling &hkl_sampling)
 initialiser: from spacegroup, cell, and HKL_sampling
void update ()
 hierarchical update
HKL_data< T > & operator= (const HKL_data< T > &other)
 assignment operator: copies the data from another list
HKL_data< T > & operator= (const T &value)
 assignment operator: assigns a single value to the whole list

Detailed Description

template<class T>
class clipper::CHKL_data< T >

Reflection data list container.

CHKL_data: This is the list object containing the actual data. It must be indexed by a parent HKL list.


Constructor & Destructor Documentation

template<class T >
clipper::CHKL_data< T >::CHKL_data ( Container parent,
const String  name = "" 
)

constructor: inherit datalist and cell

The object is constructed at the given location in the hierarchy. An attempt is made to initialise the object using information from its parents in the hierarchy.

Parameters:
parentAn object in the hierarchy (usually the parent of the new object).
nameThe path from parent to the new object (usually just the name of the new object).

References clipper::CHKL_data< T >::init().


Member Function Documentation

template<class T >
void clipper::CHKL_data< T >::init ( const HKL_info hkl_info,
const Cell cell 
) [virtual]

initialiser: supply or inherit hkl list, and cell

An attempt is made to initialise the object using information from the supplied parameters, or if they are Null, from its parents in the hierarchy.

Parameters:
hkl_infoThe reflection list object for this datalist.
cellThe cell object for this datalist.

Reimplemented from clipper::HKL_data< T >.

References clipper::HKL_info::cell(), clipper::Cell::is_null(), clipper::HKL_info::is_null(), and clipper::Container::update().

Referenced by clipper::CHKL_data< T >::CHKL_data().

template<class T >
void clipper::CHKL_data< T >::update ( ) [virtual]

hierarchical update

Hierarchical update. If this object is uninitialised, an attempt is made to initialise the object using information from its parents in the hierarchy. The childen of the object are then updated.

The data list is also synchronized with the parent reflection list.

Reimplemented from clipper::Container.

References clipper::HKL_data_base::is_null(), clipper::HKL_data< T >::update(), and clipper::Container::update().


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