BALL::TrajectoryFileFactory Class Reference

#include <BALL/FORMAT/trajectoryFileFactory.h>

Static Public Member Functions
static TrajectoryFile *	open (const String &name, File::OpenMode open_mode=std::ios::in)
static TrajectoryFile *	open (const String &name, File::OpenMode open_mode, String default_format)
static TrajectoryFile *	open (const String &name, File::OpenMode open_mode, TrajectoryFile *default_format_file)
static String	getSupportedFormats ()
static bool	isFileExtensionSupported (String filename)

Detailed Description

This class offers a factory method that given a path to a trajectory file determines the file type based on the file extension and returns a pointer to an appropriate subclass of TrajectoryFile

Definition at line 22 of file trajectoryFileFactory.h.

Member Function Documentation

static String BALL::TrajectoryFileFactory::getSupportedFormats ( )

static

Return a comma-separated string containing the file-extensions that are supported by TrajectoryFileFactory

static bool BALL::TrajectoryFileFactory::isFileExtensionSupported ( String  filename )

static

Return true if the extension of the specified filename is supported; otherwise return false.

static TrajectoryFile* BALL::TrajectoryFileFactory::open ( const String &  name, File::OpenMode  open_mode = std::ios::in  )

static

Open a file. This method tries to determine the filetype based on the file extension of name and returns a pointer to an object of the appropriate subclass of TrajectoryFile if available. If the file should be opened in read-mode and the extension is unknown or the file does not have an extension, we try to automatically detect the format. If the detection fails, NULL is returned.

Parameters

name	the path to the requested molecule file

Returns

a pointer to a subclass of TrajectoryFile, NULL if none is appropriate. Be aware that the file handle has not been checked for validity and that you have to delete it yourself

static TrajectoryFile* BALL::TrajectoryFileFactory::open ( const String &  name, File::OpenMode  open_mode, String  default_format  )

static

Open a file. When trying to open a file in write-mode, this function can be used to pass along a desired default-format. If the given filename does not have a supported extension, the specified default format will be used.

static TrajectoryFile* BALL::TrajectoryFileFactory::open ( const String &  name, File::OpenMode  open_mode, TrajectoryFile *  default_format_file  )

static

Open a file. When trying to open a file in write-mode, this function can be used to pass along a desired default-format. If the given filename does not have a supported extension, the format of 'default_format_file' will be used.