Skip to content

Commit

Permalink
Avoid use of time_t when using sliders in GUI
Browse files Browse the repository at this point in the history 
* Avoid use of time_t when using sliders in GUI
Sliders use int as internal representation of values, and time_t can cause overflow
  • Loading branch information
@magnesj
magnesj authored Oct 12, 2023
1 parent cdda748 commit 4a3cdc4
Show file tree
Hide file tree
Showing 7 changed files with 199 additions and 95 deletions.
1 change: 0 additions & 1 deletion ApplicationLibCode/Commands/SummaryPlotCommands/RicCreateDeclineCurvesFeature.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,6 @@ RimSummaryDeclineCurve* RicCreateDeclineCurvesFeature::createDeclineCurveAndAddT

RiaSummaryTools::copyCurveAxisData( *newCurve, *sourceCurve );

newCurve->updateDefaultValues();
newCurve->loadDataAndUpdate( true );
newCurve->updateConnectedEditors();

Expand Down
87 changes: 66 additions & 21 deletions ApplicationLibCode/ProjectDataModel/Summary/RimEnsembleCurveSet.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -207,14 +207,14 @@ RimEnsembleCurveSet::RimEnsembleCurveSet()
CAF_PDM_InitFieldNoDefault( &m_minDateRange, "MinDateRange", "From" );
m_minDateRange.uiCapability()->setUiEditorTypeName( caf::PdmUiDateEditor::uiEditorTypeName() );

CAF_PDM_InitFieldNoDefault( &m_minTimeStep, "MinTimeStep", "" );
m_minTimeStep.uiCapability()->setUiEditorTypeName( caf::PdmUiSliderEditor::uiEditorTypeName() );
CAF_PDM_InitField( &m_minTimeSliderPosition, "MinTimeSliderPosition", 0, "" );
m_minTimeSliderPosition.uiCapability()->setUiEditorTypeName( caf::PdmUiSliderEditor::uiEditorTypeName() );

CAF_PDM_InitFieldNoDefault( &m_maxDateRange, "MaxDateRange", "To" );
m_maxDateRange.uiCapability()->setUiEditorTypeName( caf::PdmUiDateEditor::uiEditorTypeName() );

CAF_PDM_InitFieldNoDefault( &m_maxTimeStep, "MaxTimeStep", "" );
m_maxTimeStep.uiCapability()->setUiEditorTypeName( caf::PdmUiSliderEditor::uiEditorTypeName() );
CAF_PDM_InitField( &m_maxTimeSliderPosition, "MaxTimeSliderPosition", 100, "" );
m_maxTimeSliderPosition.uiCapability()->setUiEditorTypeName( caf::PdmUiSliderEditor::uiEditorTypeName() );

// Time Step Selection
CAF_PDM_InitFieldNoDefault( &m_timeStepFilter, "TimeStepFilter", "Available Time Steps" );
Expand Down Expand Up @@ -466,6 +466,37 @@ void RimEnsembleCurveSet::setSummaryAddressX( RifEclipseSummaryAddress address )
m_xAddressSelector->setAddress( address );
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
std::pair<time_t, time_t> RimEnsembleCurveSet::fullTimeStepRange() const
{
if ( !allAvailableTimeSteps().empty() )
{
auto min = *allAvailableTimeSteps().begin();
auto max = *allAvailableTimeSteps().rbegin();

return { min, max };
}

return {};
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
std::pair<time_t, time_t> RimEnsembleCurveSet::selectedTimeStepRange() const
{
// Scale the slider values to the full time step range

auto [min, max] = fullTimeStepRange();
auto range = max - min;
auto selectedMin = min + static_cast<time_t>( range * ( m_minTimeSliderPosition / 100.0 ) );
auto selectedMax = min + static_cast<time_t>( range * ( m_maxTimeSliderPosition / 100.0 ) );

return { selectedMin, selectedMax };
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
Expand Down Expand Up @@ -867,8 +898,8 @@ void RimEnsembleCurveSet::fieldChangedByUi( const caf::PdmFieldHandle* changedFi
summaryAddress->setAddress( m_yValuesSummaryAddress->address() );
m_objectiveValuesSummaryAddresses.push_back( summaryAddress );
updateAddressesUiField();
m_minTimeStep = *allAvailableTimeSteps().begin();
m_maxTimeStep = *allAvailableTimeSteps().rbegin();
m_minTimeSliderPosition = 0;
m_maxTimeSliderPosition = 100;
updateMaxMinAndDefaultValues();
}
}
Expand All @@ -893,16 +924,26 @@ void RimEnsembleCurveSet::fieldChangedByUi( const caf::PdmFieldHandle* changedFi
updateObjectiveFunctionLegend();
updateMaxMinAndDefaultValues();
}
else if ( changedField == &m_minTimeStep || changedField == &m_maxTimeStep )
else if ( changedField == &m_minTimeSliderPosition || changedField == &m_maxTimeSliderPosition )
{
updateMaxMinAndDefaultValues();
updateCurveColors();
updateTimeAnnotations();
}
else if ( changedField == &m_minDateRange || changedField == &m_maxDateRange )
{
m_minTimeStep = RiaTimeTTools::fromQDateTime( RiaQDateTimeTools::createDateTime( m_minDateRange() ) );
m_maxTimeStep = RiaTimeTTools::fromQDateTime( RiaQDateTimeTools::createDateTime( m_maxDateRange() ) );
auto [min, max] = fullTimeStepRange();
auto range = max - min;

auto minTime = RiaTimeTTools::fromQDateTime( RiaQDateTimeTools::createDateTime( m_minDateRange() ) );
minTime = std::clamp( minTime, min, max );
auto maxTime = RiaTimeTTools::fromQDateTime( RiaQDateTimeTools::createDateTime( m_maxDateRange() ) );
maxTime = std::clamp( maxTime, min, max );

// Convert from date to normalized value between 0 and 100
m_minTimeSliderPosition = static_cast<int>( ( double( minTime - min ) / double( range ) ) * 100 );
m_maxTimeSliderPosition = static_cast<int>( ( double( maxTime - min ) / double( range ) ) * 100 );

updateCurveColors();
updateTimeAnnotations();
}
Expand Down Expand Up @@ -1005,8 +1046,8 @@ void RimEnsembleCurveSet::fieldChangedByUi( const caf::PdmFieldHandle* changedFi
setTimeSteps( indices );
}

m_minTimeStep = *allAvailableTimeSteps().begin();
m_maxTimeStep = *allAvailableTimeSteps().rbegin();
m_minTimeSliderPosition = 0;
m_maxTimeSliderPosition = 100;

updateLegendMappingMode();
updateCurveColors();
Expand Down Expand Up @@ -1142,8 +1183,10 @@ void RimEnsembleCurveSet::defineUiOrdering( QString uiConfigName, caf::PdmUiOrde
//--------------------------------------------------------------------------------------------------
void RimEnsembleCurveSet::updateMaxMinAndDefaultValues()
{
m_minDateRange = QDateTime::fromSecsSinceEpoch( m_minTimeStep ).date();
m_maxDateRange = QDateTime::fromSecsSinceEpoch( m_maxTimeStep ).date();
auto [minTimeStep, maxTimeStep] = selectedTimeStepRange();

m_minDateRange = QDateTime::fromSecsSinceEpoch( minTimeStep ).date();
m_maxDateRange = QDateTime::fromSecsSinceEpoch( maxTimeStep ).date();

for ( auto filter : m_curveFilters->filters() )
{
Expand Down Expand Up @@ -1299,9 +1342,9 @@ void RimEnsembleCurveSet::appendColorGroup( caf::PdmUiOrdering& uiOrdering )
m_customObjectiveFunction()->weightContainsFunctionType( RimObjectiveFunction::FunctionType::F1 ) ) )
{
timeSelectionGroup->add( &m_minDateRange );
timeSelectionGroup->add( &m_minTimeStep );
timeSelectionGroup->add( &m_minTimeSliderPosition );
timeSelectionGroup->add( &m_maxDateRange );
timeSelectionGroup->add( &m_maxTimeStep );
timeSelectionGroup->add( &m_maxTimeSliderPosition );
}
if ( m_objectiveFunction()->functionType() == RimObjectiveFunction::FunctionType::F2 ||
( m_customObjectiveFunction() &&
Expand Down Expand Up @@ -1391,12 +1434,12 @@ void RimEnsembleCurveSet::defineEditorAttribute( const caf::PdmFieldHandle* fiel
attrib->m_buttonText = "...";
}

if ( field == &m_minTimeStep || field == &m_maxTimeStep )
if ( field == &m_minTimeSliderPosition || field == &m_maxTimeSliderPosition )
{
if ( auto* myAttr = dynamic_cast<caf::PdmUiSliderEditorAttribute*>( attribute ) )
{
myAttr->m_minimum = *allAvailableTimeSteps().begin();
myAttr->m_maximum = *allAvailableTimeSteps().rbegin();
myAttr->m_minimum = 0;
myAttr->m_maximum = 100;
myAttr->m_showSpinBox = false;
}
}
Expand Down Expand Up @@ -1544,7 +1587,7 @@ QList<caf::PdmOptionItemInfo> RimEnsembleCurveSet::calculateValueOptions( const
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
std::set<time_t> RimEnsembleCurveSet::allAvailableTimeSteps()
std::set<time_t> RimEnsembleCurveSet::allAvailableTimeSteps() const
{
std::set<time_t> timeStepUnion;

Expand Down Expand Up @@ -1734,7 +1777,8 @@ void RimEnsembleCurveSet::updateObjectiveFunctionLegend()
//--------------------------------------------------------------------------------------------------
ObjectiveFunctionTimeConfig RimEnsembleCurveSet::objectiveFunctionTimeConfig() const
{
return { m_minTimeStep(), m_maxTimeStep(), selectedTimeSteps() };
auto [minTimeStep, maxTimeStep] = selectedTimeStepRange();
return { minTimeStep, maxTimeStep, selectedTimeSteps() };
}

//--------------------------------------------------------------------------------------------------
Expand Down Expand Up @@ -1934,7 +1978,8 @@ void RimEnsembleCurveSet::updateTimeAnnotations()
( m_colorMode() == ColorMode::BY_CUSTOM_OBJECTIVE_FUNCTION && m_customObjectiveFunction() &&
m_customObjectiveFunction()->weightContainsFunctionType( RimObjectiveFunction::FunctionType::F1 ) ) )
{
plot->addTimeRangeAnnotation( m_minTimeStep, m_maxTimeStep );
auto [minTimeStep, maxTimeStep] = selectedTimeStepRange();
plot->addTimeRangeAnnotation( minTimeStep, maxTimeStep );
}

if ( ( m_colorMode() == ColorMode::BY_OBJECTIVE_FUNCTION &&
Expand Down
9 changes: 6 additions & 3 deletions ApplicationLibCode/ProjectDataModel/Summary/RimEnsembleCurveSet.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 +209,7 @@ class RimEnsembleCurveSet : public caf::PdmObject, public RimEnsembleCurveSetInt
void defineEditorAttribute( const caf::PdmFieldHandle* field, QString uiConfigName, caf::PdmUiEditorAttribute* attribute ) override;

QList<caf::PdmOptionItemInfo> calculateValueOptions( const caf::PdmFieldHandle* fieldNeedingOptions ) override;
std::set<time_t> allAvailableTimeSteps();
std::set<time_t> allAvailableTimeSteps() const;
std::set<RimSummaryCase*> timestepDefiningSourceCases();
RiaSummaryCurveDefinitionAnalyser* getOrCreateSelectedCurveDefAnalyser();
std::vector<RiaSummaryCurveDefinition> curveDefinitions() const;
Expand Down Expand Up @@ -241,6 +241,9 @@ class RimEnsembleCurveSet : public caf::PdmObject, public RimEnsembleCurveSetInt

void setSummaryAddressX( RifEclipseSummaryAddress address );

std::pair<time_t, time_t> fullTimeStepRange() const;
std::pair<time_t, time_t> selectedTimeStepRange() const;

private:
caf::PdmField<bool> m_showCurves;
caf::PdmChildArrayField<RimSummaryCurve*> m_curves;
Expand Down Expand Up @@ -277,8 +280,8 @@ class RimEnsembleCurveSet : public caf::PdmObject, public RimEnsembleCurveSetInt
caf::PdmField<QString> m_objectiveValuesSummaryAddressesUiField;
caf::PdmField<bool> m_objectiveValuesSelectSummaryAddressPushButton;
caf::PdmPtrField<RimCustomObjectiveFunction*> m_customObjectiveFunction;
caf::PdmField<time_t> m_minTimeStep;
caf::PdmField<time_t> m_maxTimeStep;
caf::PdmField<int> m_minTimeSliderPosition;
caf::PdmField<int> m_maxTimeSliderPosition;
caf::PdmField<QDate> m_minDateRange;
caf::PdmField<QDate> m_maxDateRange;
caf::PdmField<TimeStepFilterEnum> m_timeStepFilter;
Expand Down
Loading

0 comments on commit 4a3cdc4

Please sign in to comment.