Pteros  2.0
Molecular modeling library for human beings!
Public Member Functions | Static Public Member Functions | List of all members
pteros::FileHandler Class Referenceabstract

Generic API for reading and writing any molecule file formats. More...

#include <file_handler.h>

+ Inheritance diagram for pteros::FileHandler:

Public Member Functions

virtual void open (char open_mode)=0
 Opens a file with given access mode. Need to be defined by derived classes.
 
virtual void close ()
 
bool read (System *sys, Frame *frame, const FileContent &what)
 Reads data, which are specified by what. More...
 
void write (const Selection &sel, const FileContent &what)
 Write data from selection specidied by what.
 
virtual FileContent get_content_type () const =0
 Reports content of this file type.
 

Static Public Member Functions

static FileHandler_ptr recognize (std::string fname)
 Recognizes file extension and returns a file handler.
 
static FileHandler_ptr open (std::string fname, char open_mode)
 Recognize file extension, open file for reading or writing and return a file handler. More...
 

Detailed Description

Generic API for reading and writing any molecule file formats.

Member Function Documentation

◆ open()

FileHandler_ptr FileHandler::open ( std::string  fname,
char  open_mode 
)
static

Recognize file extension, open file for reading or writing and return a file handler.

This function is aquivalent to:

auto f = Mol_file::recognize(fname);
f.open(mode);

◆ read()

bool FileHandler::read ( System *  sys,
Frame *  frame,
const FileContent &  what 
)

Reads data, which are specified by what.

Pointers to System and Frame could be nullptr if not used Returns true if read operation is succesfull and false if not.

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