itasca::IInputRecord Class Reference

The input record maintains a list of all commands used in the creation of the model. More...

#include <iinputrecord.h>

Classes
struct	FileData
	This struct holds file information stored in FileDataSet. More...

Public Types
using	FileDataSet = QSet< FileData >
	A list of files.

Public Member Functions
virtual QObject *	getQObject ()=0
	Return a QObject pointer to this object - useful for connecting Qt signals and slots.
virtual const QObject *	getQObject () const =0
	Return a const QObject pointer to this object.
virtual quint64	getTotalInputLines () const =0
	Return the total number of lines in the input record.
virtual QStringList	getInputLines (quint64 start=0, quint64 len=limits< quint64 >::max()) const =0
virtual FileDataSet	getInputFiles () const =0
	Return a list of the files used in the input record.
virtual quint64	getTimeToPlayback (quint64 marksToUndo) const =0
virtual bool	canSmartUndo (quint64 marksToUndo) const =0
virtual bool	isPlaybackActive () const =0
	Return true if an undo operation is being performed or a call file is being executed.
virtual QStringList	filterInputForDataFile (const QStringList &input) const =0
	Filters out all non-command lines and interrupted lines, moves FISH CREATE commands to the front.
virtual void	addFile (const QString &fullPath, const QString &role)=0
	Add a file to the input record.
virtual void	lineAdded (const QString &line)=0
	Signal emitted when a line is added.
virtual void	inputLineModified (qint64 line, const QString &newLine)=0
	Signal emitted when the last input line is modified.
virtual void	inputLineRemoved (qint64 line)=0
virtual void	fileAdded (const IInputRecord::FileData &fd)=0
	Signal emitted when afile was added to the input record.
virtual void	dataReset (qint64 lines)=0
virtual void	playbackActiveChanged (bool on, double timeExpected)=0

Detailed Description

The input record maintains a list of all commands used in the creation of the model.

Member Function Documentation

dataReset()

virtual void itasca::IInputRecord::dataReset ( qint64  lines )

pure virtual

Resets the input record data. The value of lines equal to-1 indicates reset to nothing, otherwise indicates number of lines

getInputLines()

virtual QStringList itasca::IInputRecord::getInputLines ( quint64  start = 0, quint64  len = limits< quint64 >::max()  ) const

pure virtual

Retrieve input lines stored in the input record. start is the line number of the first line to retrieve. len is the number of lines to retrieve.

getTimeToPlayback()

virtual quint64 itasca::IInputRecord::getTimeToPlayback ( quint64  marksToUndo ) const

pure virtual

Return the estimated time (in milliseconds) required to perform an undo operation. marksToUndo is the number of actions to undo.

playbackActiveChanged()

virtual void itasca::IInputRecord::playbackActiveChanged ( bool  on, double  timeExpected  )

pure virtual

Signal emitted to indicate when playback starts or stops. TRUE indicates playback started, FALSE indicates playback stopped.

---

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

• C:/Source/itasca-suite/common/utility/interface/iinputrecord.h