dataset Class Reference

Safe access to CMtz::MTZSET* owned by an iotbx::mtz::crystal . More...

#include <dataset.h>

List of all members.

Public Member Functions

 dataset ()
 Not available from Python.
 dataset (crystal const &mtz_crystal, int i_dataset)
 Initialization given a mtz_crystal and an integer index into the list of datasets owned by the mtz_crystal.
crystal mtz_crystal () const
 The contained iotbx::mtz::crystal instance.
int i_dataset () const
 Integer index into the list of datasets owned by mtz_crystal() .
object mtz_object () const
 Shorthand for mtz_crystal().mtz_object() .
CMtz::MTZSET * ptr () const
 Raw C pointer. Not available from Python.
int id () const
 Read-only access.
datasetset_id (int id)
 Write access.
const char * name () const
 Read-only access.
datasetset_name (const char *new_name)
 Write access.
float wavelength () const
 Read-only access.
datasetset_wavelength (float new_wavelength)
 Write access.
int n_batches () const
 Read-only access.
af::shared< batchbatches () const
 Read-only access.
batch add_batch ()
 Adds a batch to this dataset.
int n_columns () const
 Read-only access.
af::shared< columncolumns () const
 Read-only access.
column add_column (const char *label, const char *type)
 Adds a column to this dataset.


Detailed Description

Safe access to CMtz::MTZSET* owned by an iotbx::mtz::crystal .

A dataset object contains (owns) an iotbx::mtz::crystal and an integer index into the list of datasets owned by the crystal.


Constructor & Destructor Documentation

dataset ( crystal const &  mtz_crystal,
int  i_dataset 
)

Initialization given a mtz_crystal and an integer index into the list of datasets owned by the mtz_crystal.

An exception is thrown if i_dataset is out of range.


Member Function Documentation

CMtz::MTZSET* ptr (  )  const

Raw C pointer. Not available from Python.

An exception is thrown if i_dataset() is out of range.

Referenced by dataset::id(), dataset::n_batches(), dataset::n_columns(), dataset::name(), dataset::set_wavelength(), and dataset::wavelength().

dataset& set_name ( const char *  new_name  ) 

Write access.

An exception is thrown if the new_name is used already by another dataset in the mtz_crystal().


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

Generated on Tue Sep 1 17:12:35 2009 for cctbx by  doxygen 1.5.6