Interface to the list of all IHistories being taken by the history logic.
More...
#include <ihistorylist.h>
|
|
virtual IContainer * | getIContainer ()=0 |
| | Returns a pointer to the container class representing a list of histories.
|
| |
| virtual const IHistory * | getFirst () const =0 |
| |
|
virtual const IHistory * | lookupWithName (const QString &id) const =0 |
| | Find the IHistory object with ID ul, or 0 if no match is found.
|
| |
| virtual uint32 | getNStep () const =0 |
| |
| virtual int64 | getData (int64 start, std::vector< double > *values=nullptr, std::vector< bool > *valid=nullptr, uint64 *step=0) const =0 |
| |
|
virtual uint32 | getNotice () const =0 |
| | Returns the NoticeManager ID for histories added/removed from the list, or additional records taken.
|
| |
|
virtual uint32 | getHistoryGeneralType () const =0 |
| | Returns the general type for an IHistory.
|
| |
|
|
shared::Signal< std::vector< bool > *, std::vector< double > * > | valuesTaken |
| |
Interface to the list of all IHistories being taken by the history logic.
◆ getData()
| virtual int64 itascaxd::IHistoryList::getData |
( |
int64 | start, |
|
|
std::vector< double > * | values = nullptr, |
|
|
std::vector< bool > * | valid = nullptr, |
|
|
uint64 * | step = 0 ) const |
|
pure virtual |
Retrieves history data. start is a file position that is assumed to be value (first is always 0).
Fills the values array and the valid array with the histories in that record.
Also returns the step number of the record.
Returns the file position after retrieving the data (can be used as start to get next record).
◆ getFirst()
| virtual const IHistory * itascaxd::IHistoryList::getFirst |
( |
| ) |
const |
|
pure virtual |
Returns the first history in the list.
You can use IHistory::getNext() to iterate through the entire list.
◆ getNStep()
| virtual uint32 itascaxd::IHistoryList::getNStep |
( |
| ) |
const |
|
pure virtual |
This value indications at what interval histories should be stored. For instance if getNStep() = 10 then histories will be stored every 10 steps.
The documentation for this class was generated from the following file:
