BALL::Bruker1DFile Class Reference

#include <BALL/FORMAT/bruker1DFile.h>

Inheritance diagram for BALL::Bruker1DFile:

Public Member Functions
Constructors and Destructors
	Bruker1DFile ()
	Bruker1DFile (const String &name, OpenMode open_mode=std::ios::in|std::ios::binary)
virtual	~Bruker1DFile ()
	Destructor. More...
Accessors
void	read (const String &name)
void	read ()
const RegularData1D &	getData () const
const JCAMPFile::EntryMap &	getParameters () const
const JCAMPFile::HeaderMap &	getHeader () const
Public Member Functions inherited from BALL::File
	File ()
	File (const String &name, OpenMode open_mode=std::ios::in)
virtual	~File ()
virtual void	clear ()
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 Attributes
Size	min_
Size	max_
JCAMPFile	pars_
	The parameters from the procs file. More...
RegularData1D	spectrum_
Protected Attributes inherited from BALL::File
String	name_
String	original_name_
OpenMode	open_mode_
bool	is_open_
bool	is_temporary_

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

Bruker 1D spectrum format. A class for handling Bruker one-dimensional NMR spectra.

Definition at line 22 of file bruker1DFile.h.

Constructor & Destructor Documentation

BALL::Bruker1DFile::Bruker1DFile

(

)

Constructor

BALL::Bruker1DFile::Bruker1DFile	(	const String &	name,
		OpenMode	open_mode = std::ios::in|std::ios::binary
	)

Constructor

Parameters

name	important: name of the Bruker-*directory*

Exceptions

Exception::FileNotFound

if the file could not be opened

virtual BALL::Bruker1DFile::~Bruker1DFile ( )

virtual

Destructor.

Member Function Documentation

const RegularData1D& BALL::Bruker1DFile::getData ( ) const

inline

Return a pointer to the spectrum.

Definition at line 59 of file bruker1DFile.h.

const JCAMPFile::HeaderMap& BALL::Bruker1DFile::getHeader ( ) const

inline

Definition at line 65 of file bruker1DFile.h.

const JCAMPFile::EntryMap& BALL::Bruker1DFile::getParameters ( ) const

inline

Definition at line 62 of file bruker1DFile.h.

void BALL::Bruker1DFile::read

(

const String &

name

)

Read a spectrum from name. It will be stored in spectrum_

void BALL::Bruker1DFile::read

(

)

Member Data Documentation

Size BALL::Bruker1DFile::max_

protected

Definition at line 75 of file bruker1DFile.h.

Size BALL::Bruker1DFile::min_

protected

Definition at line 74 of file bruker1DFile.h.

JCAMPFile BALL::Bruker1DFile::pars_

protected

The parameters from the procs file.

Definition at line 78 of file bruker1DFile.h.

RegularData1D BALL::Bruker1DFile::spectrum_

protected

Definition at line 80 of file bruker1DFile.h.