xc
Public Member Functions | List of all members
XC::FilePlotter Class Reference

A FilePlotter will create a line graph using xy points found in a file. More...

#include <FilePlotter.h>

Inheritance diagram for XC::FilePlotter:
XC::Recorder XC::MovableObject XC::DistributedBase

Public Member Functions

 FilePlotter (const std::string &fileName, const std::string &windowTitle, int xLoc, int yLoc, int width, int height, double dT)
 
 FilePlotter (const std::string &fileName1, const std::string &fileName2, const std::string &windowTitle, int xLoc, int yLoc, int width, int height, double dT)
 
int plotFile (void)
 
int plotFiles (void)
 
int record (int commitTag, double timeStamp)
 Invoked by the Domain object after commit() has been invoked on all the domain component objects. More...
 
int playback (int commitTag)
 //! Invoked by the analyst after the analysis has been performed. More...
 
int restart (void)
 Invoked by the Domain object when revertToStart() is invoked on the Domain object. More...
 
int setFile (const std::string &newFile)
 
int setCol (const ID &theCols)
 
- Public Member Functions inherited from XC::Recorder
 Recorder (int classTag)
 
virtual int setDomain (Domain &theDomain)
 
virtual int sendSelf (CommParameters &)
 Send the object. More...
 
virtual int recvSelf (const CommParameters &)
 Receive the object. More...
 
- Public Member Functions inherited from XC::MovableObject
 MovableObject (int classTag, int dbTag)
 Constructor. More...
 
 MovableObject (int classTag)
 Constructor. More...
 
 MovableObject (const MovableObject &)
 Copy constructor. Doesn't copy the dbTag.
 
MovableObjectoperator= (const MovableObject &)
 Assignment operator. Doesn't copy the dbTag.
 
int getClassTag (void) const
 Return the class identifier.
 
int getDbTag (void) const
 Return the object identifier in the database.
 
int getDbTag (CommParameters &)
 Return the object identifier in the database.
 
void setDbTag (int dbTag)
 Sets the object identifier in the database.
 
void setDbTag (CommParameters &)
 Sets the object identifier in the database if not already set. More...
 
virtual int setParameter (const std::vector< std::string > &argv, Parameter &param)
 Sets the value param to the parameter argv.
 
virtual int updateParameter (int parameterID, Information &info)
 Updates the parameter identified by parameterID with info.
 
virtual int activateParameter (int parameterID)
 Activates the parameter identified by parameterID.
 
virtual int setVariable (const std::string &variable, Information &)
 Set the value of the variable idenfified by var.
 
virtual int getVariable (const std::string &variable, Information &)
 Return the value of the variable idenfified by var.
 
- Public Member Functions inherited from XC::DistributedBase
 DistributedBase (void)
 Constructor.
 
virtual DbTagDatagetDbTagData (void) const
 Returns a vector to store class dbTags.
 
const int & getDbTagDataPos (const int &i) const
 Returns the data at the i-th position.
 
void setDbTagDataPos (const int &i, const int &v)
 Sets the data at the i-th position.
 
void inicComm (const int &dataSize) const
 Initializes communication.
 

Detailed Description

A FilePlotter will create a line graph using xy points found in a file.

Probably to deprecate.

Member Function Documentation

§ playback()

int XC::FilePlotter::playback ( int  commitTag)
virtual

//! Invoked by the analyst after the analysis has been performed.

What the method does depends on the concrete subtype.

Reimplemented from XC::Recorder.

§ record()

int XC::FilePlotter::record ( int  commitTag,
double  timeStamp 
)
virtual

Invoked by the Domain object after commit() has been invoked on all the domain component objects.

What the Recorder records depends on the concrete subtype.

Implements XC::Recorder.

§ restart()

int XC::FilePlotter::restart ( void  )
virtual

Invoked by the Domain object when revertToStart() is invoked on the Domain object.

What the Recorder does depends on the concrete subtype.

Reimplemented from XC::Recorder.


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