Clipper
Public Member Functions | Protected Attributes | List of all members
clipper::Cell_descr Class Reference

cell description (automatically converts to radians) More...

#include <cell.h>

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

Public Member Functions

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

Protected Attributes

ftype a_
 
ftype b_
 
ftype c_
 
ftype alpha_
 
ftype beta_
 
ftype gamma_
 

Detailed Description

cell description (automatically converts to radians)

The cell description is a compact description of a cell, containing just the cell parameters. It is usually used to construct a full Cell object, which provides the expected functionality.

Constructor & Destructor Documentation

clipper::Cell_descr::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

Parameters
aA axis in Angstroms.
bB axis in Angstroms.
cC axis in Angstroms.
alphaAngle between B and C axes in radians or degrees, default=90
betaAngle between A and C axes in radians or degrees, default=90
gammaAngle between A and C axes in radians or degrees, default=90

Member Function Documentation

ftype clipper::Cell_descr::alpha_deg ( ) const

get alpha in degrees

Returns
The cell angle in degrees
ftype clipper::Cell_descr::beta_deg ( ) const

get alpha in degrees

Returns
The cell angle in degrees
ftype clipper::Cell_descr::gamma_deg ( ) const

get gamma in degrees

Returns
The cell angle in degrees
String clipper::Cell_descr::format ( ) const

return formatted String representation

Returns
A string describing the cell

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