Diffpack Documentation

Main Page Class Hierarchy Alphabetical List Compound List File List Compound Members File Members Search

CurvePlotFile Class Reference

manager of CurvePlot objects for curve plotting. More...

#include <CurvePlot.h>

Inheritance diagram for CurvePlotFile::

Public Methods
	CurvePlotFile ()
	CurvePlotFile (const String &filename)
	~CurvePlotFile ()
void	open (const String &filename)
bool	ok () const
String	getFilename () const

Detailed Description

manager of CurvePlot objects for curve plotting.

NAME: CurvePlotFile - manager of CurvePlot objects for curve plotting

DESCRIPTION:

See documentation in class "CurvePlot".

Constructor & Destructor Documentation

CurvePlotFile::CurvePlotFile ( )

The "CurvePlotFile" object must be initialized with a file name. This file name reflects the stem of the names of all the files that are generated for storing the curves managed by this "CurvePlotFile" object. Usually, the file name equals the case name (the global string "casename"). The file name can be given to the constructor, or one can allocate a "CurvePlotFile" object using the constructor without arguments and then later call the "open" function to set a proper file name. The common usage is to follow the latter approach. The "open" function is usually called in some "scan" or other initialization procedure in an application program or class.

CurvePlotFile::CurvePlotFile ( const String & filename )

See documentation of one of the overloaded constructor.

CurvePlotFile::~CurvePlotFile ( )

Member Function Documentation

String CurvePlotFile::getFilename ( ) const [inline]

returns the current file name a set by the constructor or by "open".

bool CurvePlotFile::ok ( ) const

returns true if a file name is set for this "CurvePlotFile" object, otherwise it returns false..

void CurvePlotFile::open ( const String & filename )

opens a curve plot file (curve plot map)using the specified file name. Curve plots associated with this "CurvePlotFile" object will be stored in files using the indicated name as stem. This function is only used when the "CurvePlotFile" object was allocated by use of the default constructor, as the constructor accepting a file name automatcially calls "open".

Friends And Related Function Documentation

class CurvePlot [friend]

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