SMILE  v2.5
Schwarzschild Modelling Interactive expLoratory Environment
Public Member Functions | List of all members
smile::CBasicIOSnapshot Class Referenceabstract

The abstract class implementing reading and writing snapshots; derived classes take the filename as the argument of the constructor. More...

#include <iosnapshot.h>

Inheritance diagram for smile::CBasicIOSnapshot:
Inheritance graph
[legend]

Public Member Functions

virtual bool readSnapshot (CPointMassSet< float > *&points)=0
 read a snapshot from the file; More...
 
virtual bool readSnapshot (CPointMassSet< double > *&points)=0
 
virtual bool writeSnapshot (const CPointMassSet< float > *points)=0
 write a snapshot to the file; return success or failure. More...
 
virtual bool writeSnapshot (const CPointMassSet< double > *points)=0
 

Detailed Description

The abstract class implementing reading and writing snapshots; derived classes take the filename as the argument of the constructor.

Member Function Documentation

virtual bool smile::CBasicIOSnapshot::readSnapshot ( CPointMassSet< float > *&  points)
pure virtual

read a snapshot from the file;

Parameters
[in,out]pointsis a pointer to the CPointMassSet class; if it is NULL then a new instance of this class is created, otherwise the content of this object is replaced by the new snapshot.
Returns
success or failure; in the latter case points may contain garbage.

Implemented in smile::CIOSnapshotGadget, smile::CIOSnapshotNemo, and smile::CIOSnapshotText.

virtual bool smile::CBasicIOSnapshot::writeSnapshot ( const CPointMassSet< float > *  points)
pure virtual

write a snapshot to the file; return success or failure.

Implemented in smile::CIOSnapshotGadget, smile::CIOSnapshotNemo, and smile::CIOSnapshotText.


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