clipper::CXmap< T > Class Template Reference

Crystallographic map container. More...

#include <container_map.h>

Inheritance diagram for clipper::CXmap< T >:

clipper::Container clipper::Xmap< T > clipper::Xmap_base

List of all members.

Public Member Functions

 CXmap ()
 null constructor
 CXmap (Container &parent, const String name="")
 constructor: inherit spacegroup, cell and grid
void init (const Spacegroup &spacegroup, const Cell &cell, const Grid_sampling &grid_sampling)
 initialiser: supply or inherit spacegroup, cell and grid
void update ()
 hierarchical update


Detailed Description

template<class T>
class clipper::CXmap< T >

Crystallographic map container.

CXmap: This is a crystallographic map.


Constructor & Destructor Documentation

template<class T >
clipper::CXmap< T >::CXmap ( Container parent,
const String  name = "" 
) [inline]

constructor: inherit spacegroup, cell and grid

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).


Member Function Documentation

template<class T >
void clipper::CXmap< T >::init ( const Spacegroup spacegroup,
const Cell cell,
const Grid_sampling grid_sampling 
) [inline]

initialiser: supply or inherit spacegroup, cell and grid

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 for the map.
name The cell for the map.
grid The grid for the map.

Reimplemented from clipper::Xmap< T >.

template<class T >
void clipper::CXmap< T >::update (  )  [inline, 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.


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

Generated on Fri Jun 12 18:03:40 2009 for Clipper by  doxygen 1.5.9