BALL::DSN6File Class Reference

#include <BALL/FORMAT/DSN6File.h>

Inheritance diagram for BALL::DSN6File:

Public Member Functions
Constructors and Destructor
	DSN6File ()
	Default constructor. More...
	DSN6File (const String &name, File::OpenMode open_mode=std::ios::in)
	Detailed constructor. More...
virtual	~DSN6File ()
	Destructor. More...
Assignment
virtual void	clear ()
	Clear method. More...
Predicates
bool	operator== (const DSN6File &file) const
	Equality operator. More...
bool	isSwappingBytes () const
Public methods for file handling
virtual bool	open (const String &name, File::OpenMode open_mode=std::ios::in)
virtual bool	readHeader ()
virtual bool	read (RegularData3D &map)
virtual bool	writeHeader ()
Public Member Functions inherited from BALL::File
	File ()
	File (const String &name, OpenMode open_mode=std::ios::in)
virtual	~File ()
bool	isValid () const
bool	open (const String &name, File::OpenMode open_mode=std::ios::in)
bool	reopen ()
bool	reopen (File::OpenMode open_mode)
void	close ()
const String &	getName () const
void	setName (const String &name)
const String &	getOriginalName () const
Size	getSize ()
File::OpenMode	getOpenMode () const
Type	getType (bool trace_link) const
bool	copyTo (const String &destination_name, Size buffer_size=4096)
bool	moveTo (const String &destination_name)
bool	remove ()
bool	renameTo (const String &new_path)
bool	truncate (Size size=0)
std::fstream &	getFileStream ()
TransformationManager &	getTransformationManager ()
const TransformationManager &	getTransformationManager () const
bool	operator== (const File &file) const
bool	operator!= (const File &file) const
bool	isOpen () const
bool	isClosed () const
bool	isAccessible () const
bool	isCanonized () const
bool	isReadable () const
bool	isWritable () const
bool	isExecutable () const

Protected Member Functions
short int	readHeaderValue_ (char *header, Position pos)
void	convertBrick_ (char *brick)

Protected Attributes
bool	swap_bytes_
	a flag indicating that we have to swap bytes when reading header values More...
Vector3	start_
	the start coordinates in grid coordinates, i.e. indices More...
Vector3	extent_
	the extent of the map More...
Vector3	sampling_rate_
	the sampling rates used for the map More...
Vector3	crystal_dimension_
	dimension of the crystal unit cell in Angstrom/sample More...
Angle	alpha_
	angles of the crystal unit cell More...
Angle	beta_
Angle	gamma_
float	cell_scaling_
	scaling factor for the cell geometry More...
float	prod_
	conversion factors for the density map More...
float	plus_
Vector3	origin_
	geometry in cartesian coordinates More...
Vector3	xaxis_
Vector3	yaxis_
Vector3	zaxis_
Protected Attributes inherited from BALL::File
String	name_
String	original_name_
OpenMode	open_mode_
bool	is_open_
bool	is_temporary_

Private Member Functions
const DSN6File &	operator= (const DSN6File &file)

Additional Inherited Members
Public Types inherited from BALL::File
typedef std::ios::openmode	OpenMode
enum	Transformation { TRANSFORMATION__EXEC = 1, TRANSFORMATION__FILTER = 2, TRANSFORMATION__URL = 3 }
enum	Type {   TYPE__UNKNOWN = 0, TYPE__DIRECTORY = 1, TYPE__CHAR_SPECIAL_FILE = 2, TYPE__BLOCK_SPECIAL_FILE = 3,   TYPE__REGULAR_FILE = 4, TYPE__SYMBOLIC_LINK = 5, TYPE__SOCKET = 6, TYPE__FIFO_SPECIAL_FILE = 7 }
Static Public Member Functions inherited from BALL::File
static Size	getSize (String name)
static Type	getType (String name, bool trace_link)
static bool	copy (String source_name, String destination_name, Size buffer_size=4096)
static bool	move (const String &source_name, const String &destination_name)
static bool	remove (String name)
static bool	rename (String old_path, String new_path)
static bool	truncate (String path, Size size=0)
static bool	createTemporaryFilename (String &temporary, const String &suffix=".TMP")
static void	enableTransformation (Transformation transformation)
static void	disableTransformation (Transformation transformation)
static bool	isTransformationEnabled (Transformation transformation)
static void	registerTransformation (const String &pattern, const String &exec)
static void	unregisterTransformation (const String &pattern)
static bool	isAccessible (String name)
static bool	isReadable (String name)
static bool	isWritable (String name)
static bool	isExecutable (String name)
Static Public Attributes inherited from BALL::File
static const OpenMode	MODE_IN
	Open for input (default) More...
static const OpenMode	MODE_OUT
	Open for output. More...
static const OpenMode	MODE_APP
	Append. Seek to end before each write operation. More...
static const OpenMode	MODE_BINARY
	Binary mode. More...
static const OpenMode	MODE_ATE
	Seek to end directly after opening. More...
static const OpenMode	MODE_TRUNC
	Truncate an existing file. More...
static const String	TRANSFORMATION_EXEC_PREFIX
	Prefix for filenames that are created through the execution of commands "exec:". More...
static const String	TRANSFORMATION_FILE_PREFIX
	Prefix for files (to mimick URL-like behavior) "file:". More...
static const String	TRANSFORMATION_FTP_PREFIX
	Prefix for FTP-transfers "ftp://". More...
static const String	TRANSFORMATION_HTTP_PREFIX
	Prefix for HTTP-transfer "http://". More...
Static Protected Attributes inherited from BALL::File
static HashSet< String >	created_temp_filenames_
static TransformationManager	transformation_manager_
static Size	transformation_methods_

Detailed Description

DSN6 density map file format. This class enables BALL to read and write DSN6 - type binary electron density maps as used by FRODO and O.

Definition at line 23 of file DSN6File.h.

Constructor & Destructor Documentation

BALL::DSN6File::DSN6File

(

)

Default constructor.

BALL::DSN6File::DSN6File	(	const String &	name,
		File::OpenMode	open_mode = std::ios::in
	)

Detailed constructor.

virtual BALL::DSN6File::~DSN6File ( )

virtual

Destructor.

Member Function Documentation

virtual void BALL::DSN6File::clear ( )

virtual

Clear method.

Reimplemented from BALL::File.

void BALL::DSN6File::convertBrick_ ( char *  brick )

protected

bool BALL::DSN6File::isSwappingBytes

(

)

const

virtual bool BALL::DSN6File::open ( const String &  name, File::OpenMode  open_mode = std::ios::in  )

virtual

open a DSN6File

Exceptions

Exception::FileNotFound

if the file could not be opened

const DSN6File& BALL::DSN6File::operator= ( const DSN6File &  file )

private

bool BALL::DSN6File::operator==

(

const DSN6File &

file

)

const

Equality operator.

virtual bool BALL::DSN6File::read ( RegularData3D &  map )

virtual

Read the file into a RegularData3D field.

virtual bool BALL::DSN6File::readHeader ( )

virtual

Read the header of an existing file. Return true if the header could be read successfully, false ow.

short int BALL::DSN6File::readHeaderValue_ ( char *  header, Position  pos  )

protected

virtual bool BALL::DSN6File::writeHeader ( )

virtual

Write a header Return true if the header could be written successfully, false ow.

Member Data Documentation

Angle BALL::DSN6File::alpha_

protected

angles of the crystal unit cell

Definition at line 115 of file DSN6File.h.

Angle BALL::DSN6File::beta_

protected

Definition at line 115 of file DSN6File.h.

float BALL::DSN6File::cell_scaling_

protected

scaling factor for the cell geometry

Definition at line 118 of file DSN6File.h.

Vector3 BALL::DSN6File::crystal_dimension_

protected

dimension of the crystal unit cell in Angstrom/sample

Definition at line 112 of file DSN6File.h.

Vector3 BALL::DSN6File::extent_

protected

the extent of the map

Definition at line 106 of file DSN6File.h.

Angle BALL::DSN6File::gamma_

protected

Definition at line 115 of file DSN6File.h.

Vector3 BALL::DSN6File::origin_

protected

geometry in cartesian coordinates

Definition at line 125 of file DSN6File.h.

float BALL::DSN6File::plus_

protected

Definition at line 122 of file DSN6File.h.

float BALL::DSN6File::prod_

protected

conversion factors for the density map

Definition at line 121 of file DSN6File.h.

Vector3 BALL::DSN6File::sampling_rate_

protected

the sampling rates used for the map

Definition at line 109 of file DSN6File.h.

Vector3 BALL::DSN6File::start_

protected

the start coordinates in grid coordinates, i.e. indices

Definition at line 103 of file DSN6File.h.

bool BALL::DSN6File::swap_bytes_

protected

a flag indicating that we have to swap bytes when reading header values

Definition at line 100 of file DSN6File.h.

Vector3 BALL::DSN6File::xaxis_

protected

Definition at line 125 of file DSN6File.h.

Vector3 BALL::DSN6File::yaxis_

protected

Definition at line 125 of file DSN6File.h.

Vector3 BALL::DSN6File::zaxis_

protected

Definition at line 125 of file DSN6File.h.