frequenz-microgrid-component-graph 0.5.0

A library for representing the components of a microgrid and the connections between them as a Directed Acyclic Graph (DAG).
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

// License: MIT
// Copyright © 2024 Frequenz Energy-as-a-Service GmbH

use crate::{ComponentGraph, Edge, Error, Node, component_category::CategoryPredicates};

impl<N, E> ComponentGraph<N, E>
where
    N: Node,
    E: Edge,
{
    /// Returns `true` if the given component has any successors.
    pub(super) fn has_successors(&self, component_id: u64) -> Result<bool, Error> {
        Ok(self.successors(component_id)?.next().is_some())
    }

    /// Returns `true` if the given component has any meter successors.
    pub(super) fn has_meter_successors(&self, component_id: u64) -> Result<bool, Error> {
        let mut has_successors = false;
        Ok(self.successors(component_id)?.any(|x| {
            has_successors = true;
            x.is_meter()
        }) && has_successors)
    }
}