Boost  v1.57.0
doxygen for www.boost.org
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
boost::graph::maybe_named_graph< Graph, Vertex, VertexProperty, void > Struct Template Reference

A graph mixin that can provide a mapping from names to vertices, and use that mapping to simplify creation and manipulation of graphs. More...

#include <named_graph.hpp>

Public Types

typedef lookup_one_property
< VertexProperty,
vertex_bundle_t >::type 
bundled_vertex_property_type
 The type of the "bundled" property, from which the name can be extracted. More...
 

Public Member Functions

void added_vertex (Vertex)
 Notify the named_graph that we have added the given vertex. More...
 
template<typename VertexIterStability >
void removing_vertex (Vertex, VertexIterStability)
 Notify the named_graph that we are removing the given vertex. More...
 
void clearing_graph ()
 Notify the named_graph that we are clearing the graph. More...
 
optional< Vertexvertex_by_property (const bundled_vertex_property_type &)
 Search for a vertex that has the given property (based on its name). More...
 

Detailed Description

template<typename Graph, typename Vertex, typename VertexProperty>
struct boost::graph::maybe_named_graph< Graph, Vertex, VertexProperty, void >

A graph mixin that can provide a mapping from names to vertices, and use that mapping to simplify creation and manipulation of graphs.

This partial specialization turns off this functionality when the VertexProperty does not have an internal vertex name.

Member Typedef Documentation

template<typename Graph , typename Vertex , typename VertexProperty >
typedef lookup_one_property<VertexProperty, vertex_bundle_t>::type boost::graph::maybe_named_graph< Graph, Vertex, VertexProperty, void >::bundled_vertex_property_type

The type of the "bundled" property, from which the name can be extracted.

Member Function Documentation

template<typename Graph , typename Vertex , typename VertexProperty >
void boost::graph::maybe_named_graph< Graph, Vertex, VertexProperty, void >::added_vertex ( Vertex  )
inline

Notify the named_graph that we have added the given vertex.

This is a no-op.

template<typename Graph , typename Vertex , typename VertexProperty >
void boost::graph::maybe_named_graph< Graph, Vertex, VertexProperty, void >::clearing_graph ( )
inline

Notify the named_graph that we are clearing the graph.

This is a no-op.

template<typename Graph , typename Vertex , typename VertexProperty >
template<typename VertexIterStability >
void boost::graph::maybe_named_graph< Graph, Vertex, VertexProperty, void >::removing_vertex ( Vertex  ,
VertexIterStability   
)
inline

Notify the named_graph that we are removing the given vertex.

This is a no-op.

template<typename Graph , typename Vertex , typename VertexProperty >
optional<Vertex> boost::graph::maybe_named_graph< Graph, Vertex, VertexProperty, void >::vertex_by_property ( const bundled_vertex_property_type )
inline

Search for a vertex that has the given property (based on its name).

This always returns an empty optional<>


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