Itasca C++ Interface
Loading...
Searching...
No Matches
Classes | Public Types | Public Member Functions | Public Attributes | List of all members
itasca::IInputRecord Class Referenceabstract

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

#include <iinputrecord.h>

Classes

struct  FileData
 
struct  FileDataHash
 

Public Types

using FileDataSet = std::unordered_set<FileData, FileDataHash>
 

Public Member Functions

virtual uint64 getTotalInputLines () const =0
 Return the total number of lines in the input record.
 
virtual StringList getInputLines (uint64 start=0, uint64 len=limits< uint64 >::max()) const =0
 
virtual FileDataSet getInputFiles () const =0
 Return a list of the files used in the input record.
 
virtual uint64 getTimeToPlayback (uint64 marksToUndo) const =0
 
virtual bool canSmartUndo (uint64 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 StringList filterInputForDataFile (const StringList &input) const =0
 Filters out all non-command lines and interrupted lines, moves FISH CREATE commands to the front.
 
virtual void addFile (const string &fullPath, const string &role)=0
 Add a file to the input record.
 

Public Attributes

shared::Signal< const string & > lineAdded
 
shared::Signal< int64, const string & > inputLineModified
 
shared::Signal< int64 > inputLineRemoved
 
shared::Signal< const IInputRecord::FileData & > fileAdded
 
shared::Signal< int64 > dataReset
 
shared::Signal< bool > undoAvailable
 
shared::Signal< bool, double > playbackActiveChanged
 

Detailed Description

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

Member Typedef Documentation

◆ FileDataSet

This struct holds file information stored in FileDataSet. A list of files.

Member Function Documentation

◆ getInputLines()

virtual StringList itasca::IInputRecord::getInputLines ( uint64 start = 0,
uint64 len = limits< uint64 >::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 uint64 itasca::IInputRecord::getTimeToPlayback ( uint64 marksToUndo) const
pure virtual

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


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