Hedgehog  0.0.0
A library to generate hybrid pipeline workflow systems
Public Member Functions | List of all members
hh::behavior::Node Class Referenceabstract

Node Behavior definition. More...

#include "node.h"

Inheritance diagram for hh::behavior::Node:
Inheritance graph
Collaboration diagram for hh::behavior::Node:
Collaboration graph

Public Member Functions

virtual std::shared_ptr< core::CoreNode > core ()=0
 Core Accessor. More...
 
virtual std::string extraPrintingInformation () const
 Adds node information to print in the dot file. More...
 
virtual bool canTerminate ()
 Determine if the node can terminate. More...
 

Detailed Description

Node Behavior definition.

Node has a core, can add information to print in the dot file, and can define the way they terminate

Definition at line 39 of file node.h.

Member Function Documentation

◆ canTerminate()

virtual bool hh::behavior::Node::canTerminate ( )
inlinevirtual

Determine if the node can terminate.

Return true if the node should terminate, False otherwise

Attention
Should override to break a cycle in a graph.
Returns
True if the node should terminate, else False.

Reimplemented in hh::AbstractTask< TaskOutput, TaskInputs >, hh::AbstractTask< GraphOutput, TaskInputs... >, hh::AbstractTask< TaskOutput, TaskInputs... >, and hh::AbstractTask< StateOutput, StateInputs... >.

Definition at line 55 of file node.h.

Here is the caller graph for this function:

◆ core()

virtual std::shared_ptr<core::CoreNode> hh::behavior::Node::core ( )
pure virtual

Core Accessor.

Attention
Should not be used by library user, only by the developer that wants to add node or functionality to the library
Returns
Node Core

Implemented in hh::AbstractTask< TaskOutput, TaskInputs >, hh::AbstractTask< GraphOutput, TaskInputs... >, hh::AbstractTask< TaskOutput, TaskInputs... >, hh::AbstractTask< StateOutput, StateInputs... >, hh::AbstractExecutionPipeline< GraphOutput, GraphInputs >, hh::AbstractExecutionPipeline< GraphOutput, GraphInputs... >, hh::Graph< GraphOutput, GraphInputs >, and hh::Graph< GraphOutput, GraphInputs... >.

◆ extraPrintingInformation()

virtual std::string hh::behavior::Node::extraPrintingInformation ( ) const
inlinevirtual

Adds node information to print in the dot file.

Returns
A string with extra information to show in the dot file

Definition at line 49 of file node.h.

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