batch Class Reference

Safe access to CMtz::MTZBAT* owned by an iotbx::mtz::object . More...

#include <batch.h>

List of all members.

Public Member Functions
	batch ()
	Not available from Python.
	batch (object const &mtz_object, int i_batch)
	Initialization given a mtz_object and an integer index into the list of batches owned by the mtz_object.
object	mtz_object () const
	The contained iotbx::mtz::object instance.
int	i_batch () const
	Integer index into the list of batches owned by mtz_object() .
CMtz::MTZBAT *	ptr () const
	Raw C pointer. Not available from Python.
const char *	title () const
batch &	set_title (const char *value)
af::shared< std::string >	gonlab () const
batch &	set_gonlab (af::const_ref< std::string > const &values)
int	ndet () const
batch &	set_ndet (int const &value)
af::shared< float >	phixyz () const
batch &	set_phixyz (af::const_ref< float > const &values)
af::shared< float >	detlm () const
batch &	set_detlm (af::const_ref< float > const &values)

---

Detailed Description

Safe access to CMtz::MTZBAT* owned by an iotbx::mtz::object .

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

All members of the CMtz::MTZBAT struct are accessible through both a read-only interface, and a write interface, e.g. title() and set_title(). The names of the access methods are determined strictly by the names in the CMtz::MTZBAT struct. The access methods are not documented individually. Please refer to the injected show() method in $IOTBX_DIST/iotbx/mtz/__init__.py to see all names.

---

Constructor & Destructor Documentation

batch	(	object const &	mtz_object,
		int	i_batch
	)			[inline]

Initialization given a mtz_object and an integer index into the list of batches owned by the mtz_object.

An exception is thrown if i_batch is out of range.

References IOTBX_ASSERT, and object::n_batches().

---

Member Function Documentation

CMtz::MTZBAT* ptr

(

)

const [inline]

Raw C pointer. Not available from Python.

The pointer is obtained by traversing the linked list of batches. An exception is thrown if i_batch() is out of range.

References IOTBX_ASSERT, object::n_batches(), and object::ptr().

---

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

• iotbx/mtz/batch.h