clipper::CHKL_info Class Reference

HKL list and indexing object container. More...

#include <container_hkl.h>

Inheritance diagram for clipper::CHKL_info:

List of all members.

Public Member Functions
	CHKL_info (const String name="", const Spacegroup &spacegroup=NullSpacegroup, const Cell &cell=NullCell, const Resolution &resolution=NullResolution, const bool &generate=false)
	constructor: make null object or top object in tree
	CHKL_info (Container &parent, const String name="", const bool &generate=false)
	constructor: inherit spacegroup, cell and resolution
void	init (const Spacegroup &spacegroup, const Cell &cell, const Resolution &resolution, const bool &generate=false)
	initialiser: supply or inherit spacegroup, cell and resolution
void	generate_hkl_list ()
	synthesize hkl list and update children
void	update ()
	hierarchical update

---

Detailed Description

HKL list and indexing object container.

CHKL_info: This is the reflection list object for reflection data objects to reference in order to identify their data entries.

---

Constructor & Destructor Documentation

clipper::CHKL_info::CHKL_info	(	const String	name = "",
		const Spacegroup &	spacegroup = NullSpacegroup,
		const Cell &	cell = NullCell,
		const Resolution &	resolution = NullResolution,
		const bool &	generate = false
	)

constructor: make null object or top object in tree

Construct and initialise as the top object in a tree.

Parameters:

spacegroup	The spacegroup.
cell	The cell.
resolution	The resolution.
generate	Generate reflection list if true.

clipper::CHKL_info::CHKL_info	(	Container &	parent,
		const String	name = "",
		const bool &	generate = false
	)

constructor: inherit spacegroup, cell and resolution

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:

parent	An object in the hierarchy (usually the parent of the new object).
name	The path from parent to the new object (usually just the name of the new object).

References init().

---

Member Function Documentation

void clipper::CHKL_info::init	(	const Spacegroup &	spacegroup,
		const Cell &	cell,
		const Resolution &	resolution,
		const bool &	generate = false
	)

initialiser: supply or inherit spacegroup, cell and resolution

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:

spacegroup	The spacegroup.
cell	The cell.
resolution	The resolution.
generate	Generate reflection list if true.

Reimplemented from clipper::HKL_info.

References clipper::HKL_info::cell(), clipper::HKL_info::init(), clipper::Resolution::is_null(), clipper::Cell::is_null(), clipper::Spacegroup::is_null(), clipper::HKL_info::resolution(), clipper::HKL_info::spacegroup(), and update().

Referenced by CHKL_info(), and update().

void clipper::CHKL_info::generate_hkl_list

(

)

synthesize hkl list and update children

The reflection list is sythesized to match the given spacegroup, cell, and resolution, and a hierarchical update is triggered to update the sizes of the reflection lists for all dependent HKL_data objects.

Reimplemented from clipper::HKL_info.

References update().

void clipper::CHKL_info::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.

Reimplemented from clipper::Container.

References init(), and clipper::HKL_info::is_null().

Referenced by generate_hkl_list(), and init().

---

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

• container_hkl.h
• container_hkl.cpp