From 3793fc057833d6c6f620dd4b23e037d3b0874880 Mon Sep 17 00:00:00 2001
From: sjunges <sebastian.junges@rwth-aachen.de>
Date: Tue, 15 Nov 2016 11:16:26 +0100
Subject: [PATCH] fixed comments
Former-commit-id: 3ef4de3618671b3739e35f0192285ec893704e19 [formerly 9420a946a328924598fbbcf8d22ed549a679af4a]
Former-commit-id: bd1f99094e4cb95554c6a572de6b61450f84741d
---
src/storage/gspn/GSPN.h | 36 ++++++++++++++++++++++--------------
1 file changed, 22 insertions(+), 14 deletions(-)
diff --git a/src/storage/gspn/GSPN.h b/src/storage/gspn/GSPN.h
index 7ff2fdc2c..14ac1f8be 100644
--- a/src/storage/gspn/GSPN.h
+++ b/src/storage/gspn/GSPN.h
@@ -63,37 +63,45 @@ namespace storm {
*/
std::shared_ptr<storm::gspn::Marking> getInitialMarking(std::map<uint64_t, uint64_t>& numberOfBits, uint64_t const& numberOfTotalBits) const;
+
/*!
* Returns the place with the corresponding id.
*
- * @param id The ID of the place.
- * @return The first element is true if the place was found.
- * If the first element is true, then the second element is the wanted place.
- * If the first element is false, then the second element is not defined.
+ * @param id The id of the place.
+ * @return A pointer to the place with the given id, and nullptr otherwise
*/
storm::gspn::Place const* getPlace(uint64_t id) const;
+
+ /*!
+ * Returns the place with the corresponding name.
+ *
+ * @param name The name of the place.
+ * @return A pointer to the place with the given name, and nullptr otherwise
+ */
storm::gspn::Place const* getPlace(std::string const& name) const;
/*!
- * Returns the timed transition with the corresponding id.
+ * Returns the timed transition with the corresponding name.
*
- * @param id The ID of the timed transition.
+ * @param name The ID of the timed transition.
*/
- storm::gspn::TimedTransition<GSPN::RateType> const* getTimedTransition(std::string const& id) const;
+ storm::gspn::TimedTransition<GSPN::RateType> const* getTimedTransition(std::string const& name) const;
/*!
- * Returns the immediate transition with the corresponding id.
+ * Returns the immediate transition with the corresponding name.
*
- * @param id The ID of the timed transition.
- * If the first element is false, then the second element is the nullptr.
+ * @param name The name of the timed transition.
+ * @return A pointer to the transition, and nullptr otherwise
*/
- storm::gspn::ImmediateTransition<GSPN::WeightType> const* getImmediateTransition(std::string const& id) const;
+ storm::gspn::ImmediateTransition<GSPN::WeightType> const* getImmediateTransition(std::string const& name) const;
/*!
- * Returns the transition with the corresponding id.
- *
+ * Returns the transition with the corresponding name
+ *
+ * @param name The name of the timed transition
+ * @return A pointer to the transition, and nullptr otherwise
*/
- storm::gspn::Transition const* getTransition(std::string const& id) const;
+ storm::gspn::Transition const* getTransition(std::string const& name) const;
/*!
* Write the gspn in a dot(graphviz) configuration.