feat: Add check for duplicate name when adding a network. (#221)

Resolves an outstanding TODO.

pywr-core/src/lib.rs

@@ -179,6 +179,8 @@ pub enum PywrError {
     NetworkNotFound(String),
     #[error("network index ({0}) not found")]
     NetworkIndexNotFound(usize),
+    #[error("network name `{0}` already exists.")]
+    NetworkNameAlreadyExists(String),
     #[error("parameters do not provide an initial value")]
     ParameterNoInitialValue,
     #[error("parameter state not found for parameter index {0}")]

pywr-core/src/models/multi.rs

@@ -114,16 +114,20 @@ impl MultiNetworkModel {
             .ok_or(PywrError::NetworkNotFound(name.to_string()))
     }
 
-    pub fn add_network(&mut self, name: &str, network: Network) -> usize {
-        // TODO check for duplicate names
+    /// Add a [`Network`] to the model. The name must be unique.
+    pub fn add_network(&mut self, name: &str, network: Network) -> Result<usize, PywrError> {
+        if self.get_network_index_by_name(name).is_ok() {
+            return Err(PywrError::NetworkNameAlreadyExists(name.to_string()));
+        }
+
         let idx = self.networks.len();
         self.networks.push(MultiNetworkEntry {
             name: name.to_string(),
             network,
             parameters: Vec::new(),
         });
 
-        idx
+        Ok(idx)
     }
 
     /// Add a transfer of data from one network to another.
@@ -392,4 +396,19 @@ mod tests {
 
         multi_model.step(&mut state).expect("Failed to step multi1-model.")
     }
+
+    #[test]
+    fn test_duplicate_network_names() {
+        let timestepper = default_timestepper();
+        let scenario_collection = ScenarioGroupCollection::default();
+
+        let mut multi_model = MultiNetworkModel::new(ModelDomain::from(timestepper, scenario_collection).unwrap());
+
+        let network = Network::default();
+        let _network1_idx = multi_model.add_network("network1", network);
+        let network = Network::default();
+        let result = multi_model.add_network("network1", network);
+
+        assert!(result.is_err());
+    }
 }