Gromacs  2024.4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Member Functions
gmx::TrajectoryFileOpener Class Reference

#include <gromacs/coordinateio/coordinatefile.h>

Description

Low level method to take care of only file opening and closing.

Public Member Functions

 TrajectoryFileOpener (const std::string &name, int filetype, const Selection &sel, const gmx_mtop_t *mtop)
 Constructor, taking all arguments needed to open valid coordinate files of any type. More...
 
 ~TrajectoryFileOpener ()
 Closes new trajectory file after finishing the writing to it.
 
t_trxstatus * outputFile ()
 Get access to initialized output file object. More...
 

Constructor & Destructor Documentation

gmx::TrajectoryFileOpener::TrajectoryFileOpener ( const std::string &  name,
int  filetype,
const Selection sel,
const gmx_mtop_t *  mtop 
)
inline

Constructor, taking all arguments needed to open valid coordinate files of any type.

Parameters
[in]nameName of the file to create.
[in]filetypeInternal filetype to know which kind we are going to have.
[in]selReference to selection of atoms to write. Needs to be valid for longer than the lifetime of the object created here.
[in]mtopTopology used to create TNG output. Needs to be valid for longer than the object created here.

Member Function Documentation

t_trxstatus * gmx::TrajectoryFileOpener::outputFile ( )

Get access to initialized output file object.

Performs lazy initialization if needed.


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