Clipper
Public Member Functions | List of all members
clipper::CCell Class Reference

CCell container. More...

#include <container_types.h>

Inheritance diagram for clipper::CCell:
clipper::Container clipper::Cell clipper::Cell_descr

Public Member Functions

 CCell (const String name="", const Cell &cell=NullCell)
 constructor: make null object or top object in tree
 
 CCell (Container &parent, const String name="", const Cell &cell=NullCell)
 constructor: make child object
 
void init (const Cell &cell_)
 initialiser: from Cell More...
 
- Public Member Functions inherited from clipper::Container
 Container (const String name="")
 constructor: make null object or top object in a tree
 
 Container (Container &parent, const String &path)
 constructor: from any other member and a relative path
 
virtual void update ()
 update: hierarchical content update function
 
String path () const
 get the path of this tree object
 
String name () const
 get the name of this tree object
 
void set_name (const String &name)
 set the name of this tree object
 
bool is_destroyed_with_parent () const
 is this object to be destroyed when parent is destroyed?
 
void set_destroyed_with_parent (const bool d=true)
 set this object to be destroyed when parent is destroyed
 
void move (const String &path)
 'move' method moves this object to somewhere else in the hierarchy
 
bool has_parent () const
 test if this object has a parent
 
const Containerparent () const
 get the parent of this object
 
Containerparent ()
 get the parent of this object
 
int num_children () const
 return number of children
 
const Containerchild (const int &i) const
 get the i'th child of this object
 
Containerchild (const int &i)
 get the i'th child of this object
 
const Containerultimate_parent () const
 get the ultimate parent of this object - the top of the tree
 
Containerultimate_parent ()
 get the ultimate parent of this object - the top of the tree
 
Containerparent_ptr ()
 get the parent of this object (NULL on fail)
 
template<class T >
T * parent_of_type_ptr ()
 search up the tree for a parent of the specified type (NULL on fail)
 
Containerfind_path_ptr (const String &path)
 find an object using a directory-like path (NULL on fail)
 
virtual ~Container ()
 destructor: virtual
 
void debug ()
 
- Public Member Functions inherited from clipper::Cell
 Cell ()
 null constructor: must initialise later
 
 Cell (const Cell_descr &cell_)
 constructor: takes a Cell descriptor
 
void init (const Cell_descr &cell_)
 initialiser More...
 
bool is_null () const
 test if object has been initialised More...
 
ftype a_star () const
 get a*
 
ftype b_star () const
 get b*
 
ftype c_star () const
 get c*
 
ftype alpha_star () const
 get alpha*
 
ftype beta_star () const
 get beta*
 
ftype gamma_star () const
 get gamma*
 
const ftypea () const
 
const ftypeb () const
 
const ftypec () const
 
const ftypealpha () const
 
const ftypebeta () const
 
const ftypegamma () const
 
ftype alpha_deg () const
 
ftype beta_deg () const
 
ftype gamma_deg () const
 
String format () const
 
const Cell_descrdescr () const
 return cell dimensions
 
const ftypevolume () const
 return cell volume
 
bool equals (const Cell &other, const ftype tol=1.0) const
 test equality with another cell More...
 
const Mat33matrix_orth () const
 return orthogonalisation matrix
 
const Mat33matrix_frac () const
 return fractionalisation matrix
 
const Metric_tensormetric_real () const
 return real space metric tensor
 
const Metric_tensormetric_reci () const
 return reciprocal space metric tensor
 
void debug () const
 
- Public Member Functions inherited from clipper::Cell_descr
 Cell_descr ()
 null constructor
 
 Cell_descr (const ftype &a, const ftype &b, const ftype &c, const ftype &alpha=90.0f, const ftype &beta=90.0f, const ftype &gamma=90.0f)
 constructor: from cell parameters More...
 
const ftypea () const
 get a
 
const ftypeb () const
 get b
 
const ftypec () const
 get c
 
const ftypealpha () const
 get alpha
 
const ftypebeta () const
 get beta
 
const ftypegamma () const
 get gamma
 
ftype alpha_deg () const
 get alpha in degrees More...
 
ftype beta_deg () const
 get alpha in degrees More...
 
ftype gamma_deg () const
 get gamma in degrees More...
 
String format () const
 return formatted String representation More...
 

Additional Inherited Members

- Protected Attributes inherited from clipper::Cell_descr
ftype a_
 
ftype b_
 
ftype c_
 
ftype alpha_
 
ftype beta_
 
ftype gamma_
 

Detailed Description

CCell container.

CCell: This has a name and a cell. It overrides the base cell for any objects below it.

Member Function Documentation

void clipper::CCell::init ( const Cell cell_)

initialiser: from Cell

The object is initialised, and children are updated.

Parameters
cell_The value to give to the contained object.

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