Represents the whole computation graph with all known units/authorities and channels within their namespaces. More...
#include <fw/FrameworkGraph.h>
Classes | |
| class | AuthorityNode |
| Represents a single authority in the framwork computation graph. More... | |
| class | ChannelNode |
| Represents a single channel in the framwork computation graph. More... | |
| class | FrameworkNode |
| Represents a framework in the framework computation graph. More... | |
| class | NamespaceNode |
| Represents a namespace in the framework computation graph within the overall namespace hierarchy. More... | |
| class | Node |
| Base class for all nodes in the framework computation graph. More... | |
Public Types | |
| typedef boost::shared_ptr< Node > | NodePtr |
| typedef boost::shared_ptr< ChannelNode > | ChannelNodePtr |
| typedef boost::shared_ptr< AuthorityNode > | AuthorityNodePtr |
| typedef boost::shared_ptr< NamespaceNode > | NamespaceNodePtr |
| typedef boost::shared_ptr< FrameworkNode > | FrameworkNodePtr |
Public Member Functions | |
| FrameworkGraph () | |
| Creates an emtpy framework graph object. More... | |
| FrameworkGraph (FrameworkGraph &&other) noexcept | |
| FrameworkGraph & | operator= (FrameworkGraph &&other) noexcept |
| void | swap (FrameworkGraph &other) |
| boost::mutex & | mutex () |
| bool | discover (boost::function< void()> changeCb=boost::function< void()>()) |
| Discovers the whole structure of all connected frameworks with its authorities, channels, services, etc. More... | |
| std::list< NodePtr > | getNodes () |
| Returns all channel and authority nodes. More... | |
| std::list< ChannelNodePtr > & | getChannels () |
| Returns all channel nodes. More... | |
| std::list< AuthorityNodePtr > & | getAuthorities () |
| Returns all authority nodes. More... | |
| std::list< NamespaceNodePtr > & | getNamespaces () |
| Returns all namespace nodes. More... | |
| std::list< FrameworkNodePtr > & | getFrameworks () |
| Returns all framework nodes. More... | |
| NamespaceNodePtr | getRootNamespace () |
| Returns the root namespace node. More... | |
| void | integrateNamespaceNode (NamespaceNodePtr node) |
| inserts a new namespace node and reparents the existing namespace nodes, if necessary. More... | |
Protected Member Functions | |
| template<typename Container , typename Key > | |
| Container::value_type | findPtr (Container &c, const Key &key) |
Protected Attributes | |
| boost::mutex | mMutex |
| std::list< AuthorityNodePtr > | mAuthorities |
| std::list< ChannelNodePtr > | mChannels |
| std::list< NamespaceNodePtr > | mNamespaces |
| std::list< FrameworkNodePtr > | mFrameworks |
| NamespaceNodePtr | mRootNamespace |
| bool | mGraphHasChanged |
Detailed Description
template<typename NodeMixin = void, typename AuthorityNodeMixin = void, typename ChannelNodeMixin = void, typename NamespaceNodeMixin = void, typename FrameworkNodeMixin = void>
class mira::FrameworkGraph< NodeMixin, AuthorityNodeMixin, ChannelNodeMixin, NamespaceNodeMixin, FrameworkNodeMixin >
Represents the whole computation graph with all known units/authorities and channels within their namespaces.
Each such component is represented as graph node. For each such node a separate class is used. For each node class, the user can specify "mixin" classes to add additional members to the nodes. The Mixins are specified as template parameters:
- NodeMixin: Mixin for all nodes
- AuthorityNodeMixin: Mixin used for authority nodes
- ChannelNodeMixin: Mixin used for channel nodes
- NamespaceNodeMixin: Mixin used for namespace nodes
- FrameworkNodeMixin: Mixin used for framework nodes
After you created an instance of this FrameworkGraph class, you can call the discover() method to collect all information about the framework computation graph. The discover() method can also be called multiple times to update the graph and the contained nodes.
Note that this class is used to collect the information on the computation network graph only. It is used for visualization purposes and to obtain the overall structure of the computation graph in a "human comprehensible format". This class is NOT intended to store any information that is required by the runtime components! Internally, all the information is distributed in different components.
Member Typedef Documentation
◆ NodePtr
◆ ChannelNodePtr
| typedef boost::shared_ptr<ChannelNode> ChannelNodePtr |
◆ AuthorityNodePtr
| typedef boost::shared_ptr<AuthorityNode> AuthorityNodePtr |
◆ NamespaceNodePtr
| typedef boost::shared_ptr<NamespaceNode> NamespaceNodePtr |
◆ FrameworkNodePtr
| typedef boost::shared_ptr<FrameworkNode> FrameworkNodePtr |
Constructor & Destructor Documentation
◆ FrameworkGraph() [1/2]
|
inline |
Creates an emtpy framework graph object.
◆ FrameworkGraph() [2/2]
|
inlinenoexcept |
Member Function Documentation
◆ operator=()
|
inlinenoexcept |
◆ swap()
|
inline |
◆ mutex()
|
inline |
◆ discover()
|
inline |
Discovers the whole structure of all connected frameworks with its authorities, channels, services, etc.
Returns true, if the graph has changed, otherwise false. The optional parameter allows to specify a callback that is called from time to time during the discovery process, whenever changes in the graph have been observed.
◆ getNodes()
|
inline |
Returns all channel and authority nodes.
◆ getChannels()
|
inline |
Returns all channel nodes.
◆ getAuthorities()
|
inline |
Returns all authority nodes.
◆ getNamespaces()
|
inline |
Returns all namespace nodes.
◆ getFrameworks()
|
inline |
Returns all framework nodes.
◆ getRootNamespace()
|
inline |
Returns the root namespace node.
◆ integrateNamespaceNode()
|
inline |
inserts a new namespace node and reparents the existing namespace nodes, if necessary.
◆ findPtr()
|
inlineprotected |
Member Data Documentation
◆ mMutex
|
protected |
◆ mAuthorities
|
protected |
◆ mChannels
|
protected |
◆ mNamespaces
|
protected |
◆ mFrameworks
|
protected |
◆ mRootNamespace
|
protected |
◆ mGraphHasChanged
|
protected |
The documentation for this class was generated from the following file:
- framework/include/fw/FrameworkGraph.h
