From f989ac13ccc8c66323b235c6886cf705cc5515cb Mon Sep 17 00:00:00 2001 From: Dimitri Baron Date: Tue, 12 Nov 2024 15:56:43 +0100 Subject: [PATCH] #428 Doxygen fix Signed-off-by: Dimitri Baron --- sources/Common/DYNSimulationResult.h | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/sources/Common/DYNSimulationResult.h b/sources/Common/DYNSimulationResult.h index 91db30f..ad7aa21 100644 --- a/sources/Common/DYNSimulationResult.h +++ b/sources/Common/DYNSimulationResult.h @@ -127,8 +127,16 @@ class SimulationResult { */ std::string getLostEquipementsStreamStr() const; + /** + * @brief getter of the final state IIDM stream associated to the scenario + * @return final state IIDM stream associated to the scenario + */ std::stringstream& getOutputIIDMStream(); + /** + * @brief getter of the final state IIDM associated to the scenario + * @return final state IIDM associated to the scenario + */ std::string getOutputIIDMStreamStr() const; /** @@ -252,7 +260,7 @@ class SimulationResult { std::stringstream timelineStream_; ///< stream for the timeline associated to the scenario std::stringstream constraintsStream_; ///< stream for the constraints associated to the scenario std::stringstream lostEquipmentsStream_; ///< stream for the lost equipments associated to the scenario - std::stringstream outputIIDMStream_; + std::stringstream outputIIDMStream_; ///< stream for the output final state IIDM dump associated to the scenario std::string scenarioId_; ///< id of the scenario double variation_; ///< variation of the scenario (aka loadLevel when associated to a load increase) bool success_; ///< @b true if the simulation reached its end, @b false otherwise