CppGraph Application Framework©
Copyright © 2004-202x Geoff Goldberg
Public Member Functions | Protected Member Functions | List of all members
cppgraph::state_machine_completed_message Struct Reference

A state-machine completed message is broadcast by a final state, when it is entered. More...

#include <state_machine_completed_message.h>

Inherits node.

Public Member Functions

cppgraph::node_handle_t< cppgraph ::state_machineget_state_machine_child () const
 [auto-generated] cppgraph :: state_machine child node access. More...
 
cppgraph::node_handle_t< cppgraph ::state_machineset_state_machine_child (cppgraph::node_handle_t< cppgraph ::state_machine > const &h_state_machine)
 [auto-generated] Replaces the child node whose class is or derived from, cppgraph :: state_machine . More...
 

Protected Member Functions

 state_machine_completed_message (node_handle_t< state_machine > const &h_state_machine)
 Construction. More...
 

Detailed Description

A state-machine completed message is broadcast by a final state, when it is entered.

Guaranteed Nodes

Object Diagram

dot_inline_dotgraph_373.png

Constructor & Destructor Documentation

◆ state_machine_completed_message()

cppgraph::state_machine_completed_message::state_machine_completed_message ( node_handle_t< state_machine > const &  h_state_machine)
protected

Construction.

Parameters
h_state_machineNode to set as this node's state machine child node.

Member Function Documentation

◆ get_state_machine_child()

cppgraph::node_handle_t< cppgraph :: state_machine > cppgraph::state_machine_completed_message::get_state_machine_child ( ) const
inline

[auto-generated] cppgraph :: state_machine child node access.

Returns
The cppgraph :: state_machine child node. It is guaranteed not to be nullptr.
Exceptions
exceptionThere is no cppgraph :: state_machine child node.
exceptionThere is more than one cppgraph :: state_machine child node.

◆ set_state_machine_child()

cppgraph::node_handle_t< cppgraph :: state_machine > cppgraph::state_machine_completed_message::set_state_machine_child ( cppgraph::node_handle_t< cppgraph ::state_machine > const &  h_state_machine)
inline

[auto-generated] Replaces the child node whose class is or derived from, cppgraph :: state_machine .

Parameters
h_state_machineHandle to a node to replace the existing node.
Returns
A handle to the node that was replaced. It is guaranteed not to be nullptr.
Exceptions
exceptionThere is no existing node whose type is of or derived from cppgraph :: state_machine .
exceptionThere is more than 1 existing node whose type is of or derived from cppgraph :: state_machine .
exceptionh_state_machine is nullptr.

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