clipper::CNXmap_operator< T > Class Template Reference

Non-Crystallographic map operator container. More...

#include <container_map.h>

Inheritance diagram for clipper::CNXmap_operator< T >:

List of all members.

Public Member Functions
	CNXmap_operator ()
	null constructor
	CNXmap_operator (Container &parent, const String name="")
	constructor: do not initialise
	CNXmap_operator (Container &parent, const String name, const NXmap< T > &nxmap, const RTop_orth &nxop=RTop_orth(RTop<>::null()))
	constructor: inherit cell and grid
void	init (const Cell &cell, const Grid_sampling &grid, const NXmap< T > &nxmap, const RTop_orth &nxop)
	initialier: supply or inherit cell, grid, NXmap, RTop_orth
void	update ()
	hierarchical update

---

Detailed Description

template<class T>
class clipper::CNXmap_operator< T >

Non-Crystallographic map operator container.

CNXmap: This is an operator relating a non-crystallographic map into a crystallgraphic frame. It can inherit the crystallographic cell and grid sampling.

---

Constructor & Destructor Documentation

template<class T >

clipper::CNXmap_operator< T >::CNXmap_operator	(	Container &	parent,
		const String	name = ""
	)

constructor: do not initialise

The object is not initialised.

Parameters:

parent	The objects parent.
name	The object name.

template<class T >

clipper::CNXmap_operator< T >::CNXmap_operator	(	Container &	parent,
		const String	name,
		const NXmap< T > &	nxmap,
		const RTop_orth &	nxop = RTop_orth(RTop<>::null())
	)

constructor: inherit cell and grid

The object is initialised if the appropriate parent objects are available, and children are updated.

Parameters:

parent	The objects parent.
name	The object name.
nxmap	The non-crystal map object.
nxop	The orth. operator mapping the NXmap into the crystal frame.

References clipper::CNXmap_operator< T >::init(), and clipper::RTop_orth::null().

---

Member Function Documentation

template<class T >

void clipper::CNXmap_operator< T >::init	(	const Cell &	cell,
		const Grid_sampling &	grid_sampling,
		const NXmap< T > &	nxmap,
		const RTop_orth &	nxop
	)

initialier: supply or inherit cell, grid, NXmap, RTop_orth

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:

cell	The unit cell for the crystallographic frame.
grid	The grid sampling for the crystallographic frame.
nxmap	The non-crystal map object.
nxop	The orth. operator mapping the NXmap into the crystal frame.

Reimplemented from clipper::NXmap_operator< T >.

References clipper::RTop< T >::is_null(), clipper::NXmap_base::is_null(), clipper::Grid_sampling::is_null(), clipper::Cell::is_null(), and clipper::Container::update().

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

template<class T >

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

Reimplemented from clipper::Container.

References clipper::NX_operator::is_null(), clipper::RTop_orth::null(), and clipper::Container::update().

---

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

• container_map.h