 |
|
IMP Reference Guide
2.21.0
The Integrative Modeling Platform
|
#include <IMP/display/Writer.h>
Inheritance diagram for IMP::display::TextWriter:A base class for writers which write to text files. By default, separate frames are stored in separate files. To change this, override the do_set_frame() method.
Public Member Functions | |
| TextWriter (TextOutput fn) | |
| Create a writer opening the file with the passed sink. More... | |
| TextWriter (std::string name) | |
| Create a write for a file or files with the passed name or pattern. More... | |
| virtual | ~TextWriter () |
| Write the data and close the file. More... | |
| std::string | get_current_file_name () const |
| get the name of the current file being written More... | |
| Public Member Functions inherited from IMP::display::Writer | |
| Writer (std::string name) | |
| Create a writer opening the file with the passed name. More... | |
| virtual | ~Writer () |
| Write the data and close the file. More... | |
| void | set_frame (unsigned int i) |
| int | get_frame () const |
| void | add_geometry (Geometry *g) |
| void | add_geometry (const Geometries &g) |
| Public Member Functions inherited from IMP::Object | |
| virtual void | clear_caches () |
| CheckLevel | get_check_level () const |
| LogLevel | get_log_level () const |
| virtual VersionInfo | get_version_info () const |
| Get information about the module and version of the object. More... | |
| void | set_check_level (CheckLevel l) |
| void | set_log_level (LogLevel l) |
| Set the logging level used in this object. More... | |
| void | set_was_used (bool tf) const |
| void | show (std::ostream &out=std::cout) const |
| const std::string & | get_name () const |
| void | set_name (std::string name) |
| virtual std::string | get_type_name () const |
Protected Member Functions | |
| virtual void | do_set_frame () override |
| in case you want to take action on a new frame More... | |
| std::ostream & | get_stream () |
| Get the stream for inheriting classes to write to. More... | |
| void | open () |
| Protected Member Functions inherited from IMP::display::Writer | |
| virtual void | do_close ()=0 |
| A hook for implementation classes to use to take actions on file close. More... | |
| virtual void | do_open ()=0 |
| A hook for implementation classes to use to take actions on file open. More... | |
| Protected Member Functions inherited from IMP::display::GeometryProcessor | |
| virtual bool | handle_anything (Geometry *, Color, std::string) |
| virtual bool | handle_bounding_box (BoundingBoxGeometry *, Color, std::string) |
| virtual bool | handle_cylinder (CylinderGeometry *, Color, std::string) |
| virtual bool | handle_ellipsoid (EllipsoidGeometry *, Color, std::string) |
| void | handle_geometry (Geometry *g) |
| virtual bool | handle_label (LabelGeometry *, Color, std::string) |
| virtual bool | handle_point (PointGeometry *, Color, std::string) |
| virtual bool | handle_polygon (PolygonGeometry *, Color, std::string) |
| virtual bool | handle_segment (SegmentGeometry *, Color, std::string) |
| virtual bool | handle_sphere (SphereGeometry *, Color, std::string) |
| virtual bool | handle_surface_mesh (SurfaceMeshGeometry *, Color, std::string) |
| virtual bool | handle_triangle (TriangleGeometry *, Color, std::string) |
| Protected Member Functions inherited from IMP::Object | |
| Object (std::string name) | |
| Construct an object with the given name. More... | |
| virtual void | do_destroy () |
| IMP::display::TextWriter::TextWriter | ( | TextOutput | fn | ) |
Create a writer opening the file with the passed sink.
Frames are not supported with this constructor when using a format such as CMM or Chimera that writes multiple frames to different files.
| IMP::display::TextWriter::TextWriter | ( | std::string | name | ) |
Create a write for a file or files with the passed name or pattern.
The name should contain %1% if you want to write different frames to separate files. Otherwise, it will either write all frames to the same file (Pymol) or overwrite the file with each new frame, Chimera, CMM.
|
virtual |
Write the data and close the file.
|
overrideprotectedvirtual |
in case you want to take action on a new frame
Reimplemented from IMP::display::Writer.
| std::string IMP::display::TextWriter::get_current_file_name | ( | ) | const |
|
protected |