Clipper
Public Member Functions
clipper::CGrid_sampling Class Reference

CGrid_sampling container. More...

#include <container_types.h>

Inheritance diagram for clipper::CGrid_sampling:
clipper::Container clipper::Grid_sampling clipper::Grid clipper::Vec3< int >

List of all members.

Public Member Functions

 CGrid_sampling (const String name="", const Grid_sampling &grid=NullGrid_sampling)
 constructor: make null object or top object in tree
 CGrid_sampling (Container &parent, const String name="", const ftype rate=1.5)
 constructor: make child object
 CGrid_sampling (Container &parent, const String name, const Grid_sampling &grid)
 constructor: make child object with explicit value
void init (const Spacegroup &spacegroup, const Cell &cell, const Resolution &resolution, const ftype rate)
 initialiser: from sampling rate
void init (const Grid_sampling &grid_sampling_)
 initialiser: from Grid_sampling
void update ()
 hierarchical update

Detailed Description

CGrid_sampling container.

CGrid_sampling: This has a name and a grid sampling It overrides the grid sampling for any objects below it.


Constructor & Destructor Documentation

clipper::CGrid_sampling::CGrid_sampling ( const String  name = "",
const Grid_sampling grid = NullGrid_sampling 
)

constructor: make null object or top object in tree

The top object in a tree is initialised from a known grid.

Parameters:
nameThe object name.
gridThe grid sampling.
clipper::CGrid_sampling::CGrid_sampling ( Container parent,
const String  name = "",
const ftype  rate = 1.5 
)

constructor: make child object

The normal form for a child object - spacegroup and cell inherited.

Parameters:
parentThe objects parent.
nameThe object name.
rateThe Shannon rate (default 1.5).

References init().

clipper::CGrid_sampling::CGrid_sampling ( Container parent,
const String  name,
const Grid_sampling grid 
)

constructor: make child object with explicit value

This is still a child object but is initialised directly.

Parameters:
parentThe objects parent.
nameThe object name.
gridThe grid sampling.

Member Function Documentation

void clipper::CGrid_sampling::init ( const Spacegroup spacegroup,
const Cell cell,
const Resolution resolution,
const ftype  rate 
)

initialiser: from sampling rate

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

Parameters:
spacegroupThe spacegroup.
cellThe cell.
resolutionThe resolution.
rate_The Shannon rate (If <1 previous value is used, default 1.5).

Reimplemented from clipper::Grid_sampling.

References clipper::Grid_sampling::init(), clipper::Resolution::is_null(), clipper::Cell::is_null(), clipper::Spacegroup::is_null(), and update().

Referenced by CGrid_sampling(), and update().

void clipper::CGrid_sampling::init ( const Grid_sampling grid_sampling_)

initialiser: from Grid_sampling

The object is initialised, and children are updated.

Parameters:
grid_sampling_The value to give to the contained object.

References update().

void clipper::CGrid_sampling::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::Grid_sampling::is_null().

Referenced by init().


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