Interface to a particular history being taken by the history logic.
More...
#include <ihistory.h>
|
|
virtual const IThing * | getIThing () const =0 |
| | Get const IThing interface pointer for the history.
|
| |
|
virtual IThing * | getIThing ()=0 |
| | Get IThing interface pointer for the history.
|
| |
|
virtual uint64 | getID () const =0 |
| | Unique ID associated with the history.
|
| |
|
virtual string | getName () const =0 |
| | This name is assigned by the code.
|
| |
| virtual string | getLabel () const =0 |
| |
| virtual bool | hasPosition () const =0 |
| |
| virtual DVect | getPosition () const =0 |
| |
|
virtual DVect2 | getValueRange () const =0 |
| | Returns the min (x) and max (y) values ever taken of the history object.
.
|
| |
| virtual bool | isValid () const =0 |
| |
| virtual bool | isActive () const =0 |
| |
| virtual int64 | getStartPosition () const =0 |
| |
| virtual int | getStorageIndex () const =0 |
| |
| virtual const IHistory * | getNext () const =0 |
| |
|
virtual bool | getRezoneEnabled () const =0 |
| | Used for for dynamic rezoning FLAC3D, returns true if this history changes zone or gp location during dynamic rezoning.
|
| |
|
|
static const TType | type_ = 0x4c815b8b |
| | The type identification number for this class, for use in convert_cast() and convert_getcast().
|
| |
Interface to a particular history being taken by the history logic.
◆ getLabel()
| virtual string itascaxd::IHistory::getLabel |
( |
| ) |
const |
|
pure virtual |
Label of the history - to be displayed in plots.
If unassigned this will return the same as getName().
Otherwise it will return a label assigned by the user.
◆ getNext()
| virtual const IHistory * itascaxd::IHistory::getNext |
( |
| ) |
const |
|
pure virtual |
Returns the next IHistory() object in the global list, or 0 if it is the last one.
◆ getPosition()
| virtual DVect itascaxd::IHistory::getPosition |
( |
| ) |
const |
|
pure virtual |
If hasPosition() is true, returns the position of the object.
Returns (0,0,0) if the history has no valid position.
◆ getStartPosition()
| virtual int64 itascaxd::IHistory::getStartPosition |
( |
| ) |
const |
|
pure virtual |
This is the position in the history temp file of the first record containing a value from this history.
◆ getStorageIndex()
| virtual int itascaxd::IHistory::getStorageIndex |
( |
| ) |
const |
|
pure virtual |
This is the position in the history record of the object.
Note that this is distinct from the ID() of the History.
◆ hasPosition()
| virtual bool itascaxd::IHistory::hasPosition |
( |
| ) |
const |
|
pure virtual |
Returns TRUE if the history is of an object with a distince position. Like a node, zone, etc.
Returns FALSE for things like out-of-balance force, time, etc.
◆ isActive()
| virtual bool itascaxd::IHistory::isActive |
( |
| ) |
const |
|
pure virtual |
Returns TRUE if the history is no longer taking values.
This could be because it isn't valid (isValid()), or because it has been explicitly de-activated.
◆ isValid()
| virtual bool itascaxd::IHistory::isValid |
( |
| ) |
const |
|
pure virtual |
Returns TRUE if the history is in a state to take more values.
Returns FALSE if not (for instance a history of a zone that has been deleted.)
The documentation for this class was generated from the following file:
- C:/Source/itasca-suite/common/module/interface/ihistory.h
