MUQ  0.4.3
muq::Modeling::NodeNameFinder Struct Reference

A helper struct that determines if a node in the graph has a given name. More...

#include <NodeNameFinder.h>

Detailed Description

A helper struct that determines if a node in the graph has a given name.

Definition at line 16 of file NodeNameFinder.h.

Public Member Functions

 NodeNameFinder (std::string const &name, Graph const &graph)
 
bool operator() (boost::graph_traits< Graph >::vertex_descriptor vertex) const
 Does a given vertex have the same name as the given name. More...
 

Public Attributes

const std::string name
 We are looking for vertices with this name. More...
 
Graph const & graph
 This graph stores the vertices. More...
 

Constructor & Destructor Documentation

◆ NodeNameFinder()

NodeNameFinder::NodeNameFinder ( std::string const &  name,
Graph const &  graph 
)
Parameters
[in]nameWe are looking for nodes with this name
[in]graphA pointer to the graph that stores the nodes

Definition at line 5 of file NodeNameFinder.cpp.

Member Function Documentation

◆ operator()()

bool NodeNameFinder::operator() ( boost::graph_traits< Graph >::vertex_descriptor  vertex) const

Does a given vertex have the same name as the given name.

param[in] vertex The vertex of the graph

Returns
true if the names are the same, false if not

Definition at line 7 of file NodeNameFinder.cpp.

References graph, and name.

Member Data Documentation

◆ graph

Graph const& muq::Modeling::NodeNameFinder::graph

This graph stores the vertices.

Definition at line 36 of file NodeNameFinder.h.

Referenced by operator()().

◆ name

const std::string muq::Modeling::NodeNameFinder::name

We are looking for vertices with this name.

Definition at line 33 of file NodeNameFinder.h.

Referenced by operator()().


The documentation for this struct was generated from the following files: