IMP logo
IMP Reference Guide  develop.298718d020,2025/02/21
The Integrative Modeling Platform
IMP::TextInput Class Reference

#include <IMP/file.h>

+ Inheritance diagram for IMP::TextInput:

Detailed Description

A TextInput can be implicitly constructed from a C++ stream, a Python filelike object or a path to a file. As a result, those can be passed directly to functions which take a TextInput as an argument.

IMP::atom::read_pdb("path/to/file.pdb", m);
IMP::atom::read_pdb(my_fstream, m);
See Also
TextOutput

Definition at line 89 of file file.h.

Public Member Functions

 TextInput (std::string file_name)
 
 TextInput (std::istream &out, std::string name="C++ stream")
 
std::string get_name () const
 
 operator bool_type () const
 
void set_binary_open_mode (bool binary)
 Control whether to open the file in text or binary mode. More...
 
void show (std::ostream &out=std::cout) const
 

Member Function Documentation

void IMP::TextInput::set_binary_open_mode ( bool  binary)

Control whether to open the file in text or binary mode.

This only has an effect on files constructed from filename, and is an error if the file has already been opened. For streams or filelike objects, open the stream in binary mode first before passing it to TextInput.

Definition at line 126 of file file.h.


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