Interface PHXDATAHISTORYLib::\_DPHXDataHistoryEvents

Definition: LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl (line 796)

Events interface for PHXDataHistory; not actually a separate interface

Members

• dataChanged
• highlightChanged
• progressMeterChange
• progressMeterEstimate
• progressMeterStart
• progressMeterStop
• variablesChanged

Public functions

Function variablesChanged

void PHXDATAHISTORYLib::_DPHXDataHistoryEvents::variablesChanged()

This event is called anytime Variables are added or removed.

Return type: void

Function progressMeterChange

void PHXDATAHISTORYLib::_DPHXDataHistoryEvents::progressMeterChange(long completed, long total)

This event is fired any time a new progress meter information is available, typically due to runs coming in.

Parameters:

• completed: The number of runs with data.
• total: The total number of expected runs.

Parameters:

• long completed
• long total

Return type: void

Function progressMeterStart

void PHXDATAHISTORYLib::_DPHXDataHistoryEvents::progressMeterStart()

This event is fired when startRuns is called.

Return type: void

Function progressMeterStop

void PHXDATAHISTORYLib::_DPHXDataHistoryEvents::progressMeterStop()

This event is fired when endRuns is called.

Return type: void

Function dataChanged

void PHXDATAHISTORYLib::_DPHXDataHistoryEvents::dataChanged(long varIndex, long runIndex)

This event is fired any time any data item within the Data History is changed.

Parameters:

• varIndex: The 0 based index to the Variable which changed. May be -1 to indicate a large sweeping change that might affect all Variables.
• runIndex: The 0 based index to the run which changed. May be -1 to indicate that a large changed happened, possibly involving all the runs.

Parameters:

• long varIndex
• long runIndex

Return type: void

Function progressMeterEstimate

void PHXDATAHISTORYLib::_DPHXDataHistoryEvents::progressMeterEstimate(long estimate)

This event is fired when the process attempts to determine how long the job is going to take time-wise based off of previous run result timings.

Parameters:

• estimate: Value of the estimate of how long the job is going to take.

Parameters:

• long estimate

Return type: void

Function highlightChanged

void PHXDATAHISTORYLib::_DPHXDataHistoryEvents::highlightChanged(long runIndex, boolean highlight, boolean handleEvent)

This event is fired when a different run is selected. Parameters:

• runIndex: The index of the run.
• highlight: Whether to visibly highlight the newly selected run.
• handleEvent: If false, will just return.

Parameters:

• long runIndex
• boolean highlight
• boolean handleEvent

Return type: void