smacc2 Namespace Reference

Namespaces
namespace	client_bases
namespace	client_behaviors
namespace	client_core_components
namespace	default_events
namespace	default_transition_tags
namespace	event_generators
namespace	introspection
namespace	state_reactors
namespace	utils

Classes
struct	AddTEventTypeStateReactor
struct	AddTEventTypeStateReactorInfo
class	CallbackCounterSemaphore
class	CbServiceServerCallbackBase
class	ClientHandler
struct	ComponentKey
struct	EvCbFailure
struct	EvCbFinished
struct	EvCbSuccess
class	HasSpecificNamedOnExit
class	HasStandardOnExit
class	ISmaccClient
class	ISmaccClientBehavior
class	ISmaccComponent
class	ISmaccOrthogonal
class	ISmaccState
class	ISmaccStateMachine
class	ISmaccUpdatable
class	Orthogonal
class	SignalDetector
class	SmaccAsyncClientBehavior
class	SmaccClientBehavior
class	SmaccEventGenerator
class	SmaccSignal
class	SmaccState
struct	SmaccStateMachineBase
	State Machine. More...
struct	SmExecution
class	StateReactor
class	Transition

Typedefs
template<class T >
using	deep_history = sc::deep_history<T>

Enumerations
enum class	SMRunMode { DEBUG , RELEASE }
enum class	ComponentRequirement { SOFT , HARD }
enum class	ExecutionModel { SINGLE_THREAD_SPINNER , MULTI_THREAD_SPINNER }
enum class	EventLifeTime { ABSOLUTE , CURRENT_STATE }
enum class	StateMachineInternalAction {   STATE_CONFIGURING , STATE_ENTERING , STATE_RUNNING , STATE_EXITING ,   TRANSITIONING }

Functions
template<typename TState , typename TTransitionTagName >
void	specificNamedOnExit (TState &st, TTransitionTagName tn, std::true_type)
template<typename TState , typename TTransitionTagName >
void	specificNamedOnExit (TState &, TTransitionTagName, std::false_type)
template<typename TState , typename TTransitionTagName >
void	specificNamedOnExit (TState &m, TTransitionTagName tn)
template<typename TState >
void	standardOnExit (TState &st, std::true_type)
template<typename TState >
void	standardOnExit (TState &, std::false_type)
template<typename TState >
void	standardOnExit (TState &m)
void	onSigQuit (int sig)
void	onSignalShutdown (int sig)
template<typename StateMachineType >
void	run (ExecutionModel executionModel=ExecutionModel::SINGLE_THREAD_SPINNER)
template<typename StateMachineType >
SmExecution *	run_async ()

Variables
std::atomic< bool >	g_shutdown_requested {false}
SignalDetector *	g_signal_detector = nullptr

Typedef Documentation

deep_history

template<class T >

using smacc2::deep_history = sc::deep_history<T>

Definition at line 54 of file common.hpp.

Enumeration Type Documentation

ComponentRequirement

enum class smacc2::ComponentRequirement

strong

Enumerator
SOFT
HARD

Definition at line 74 of file common.hpp.

{
  SOFT,
  HARD
};

EventLifeTime

enum class smacc2::EventLifeTime

strong

Enumerator
ABSOLUTE
CURRENT_STATE

Definition at line 46 of file smacc_state_machine.hpp.

{
  ABSOLUTE,
  CURRENT_STATE /*events are discarded if we are leaving the state it were created. I is used for client behaviors whose lifetime is associated to state*/
};

ExecutionModel

enum class smacc2::ExecutionModel

strong

Enumerator
SINGLE_THREAD_SPINNER
MULTI_THREAD_SPINNER

Definition at line 29 of file smacc_signal_detector.hpp.

{
  SINGLE_THREAD_SPINNER,
  MULTI_THREAD_SPINNER
};

SMRunMode

enum class smacc2::SMRunMode

strong

Enumerator
DEBUG
RELEASE

Definition at line 68 of file common.hpp.

{
  DEBUG,
  RELEASE
};

StateMachineInternalAction

enum class smacc2::StateMachineInternalAction

strong

Enumerator
STATE_CONFIGURING
STATE_ENTERING
STATE_RUNNING
STATE_EXITING
TRANSITIONING

Definition at line 52 of file smacc_state_machine.hpp.

{
  STATE_CONFIGURING,
  STATE_ENTERING,
  STATE_RUNNING,
  STATE_EXITING,
  TRANSITIONING
};

Function Documentation

onSignalShutdown()

void smacc2::onSignalShutdown

(

int

sig

)

Definition at line 389 of file signal_detector.cpp.

{
  // IMPORTANT: Signal handlers can only call async-signal-safe functions
  // We must NOT call complex C++ methods here (like terminateScheduler)
  // as they may use mutexes/condition variables which are not signal-safe
 
  // Set global shutdown flag (atomic operation - signal-safe)
  g_shutdown_requested = true;
 
  // Stop the signal detector loop (atomic operation - signal-safe)
  if (g_signal_detector)
  {
    g_signal_detector->stop();
  }
 
  // Trigger ROS2 shutdown (this handles its own signal safety)
  rclcpp::shutdown();
 
  // Note: Scheduler termination will happen from main thread after polling loop exits
}

References g_shutdown_requested, g_signal_detector, and smacc2::SignalDetector::stop().

Referenced by run(), and run_async().

Here is the call graph for this function:

Here is the caller graph for this function:

onSigQuit()

void smacc2::onSigQuit

(

int

sig

)

Definition at line 410 of file signal_detector.cpp.

{
  RCLCPP_INFO(rclcpp::get_logger("SMACC"), "SignalDetector: SIGQUIT received.");
  exit(0);
}

Referenced by run(), and run_async().

Here is the caller graph for this function:

run()

template<typename StateMachineType >

void smacc2::run

(

ExecutionModel

executionModel = ExecutionModel::SINGLE_THREAD_SPINNER

)

Definition at line 124 of file smacc_signal_detector.hpp.

{
  // Register signal handlers for graceful shutdown
  ::signal(SIGINT, onSignalShutdown);
  ::signal(SIGTERM, onSignalShutdown);
  ::signal(SIGQUIT, onSigQuit);
 
  // create the asynchronous state machine scheduler
  SmaccFifoScheduler scheduler1(true);
 
  // create the signalDetector component
  SignalDetector signalDetector(&scheduler1, executionModel);
 
  // Store global reference for signal handler access
  g_signal_detector = &signalDetector;
 
  // create the asynchronous state machine processor
  SmaccFifoScheduler::processor_handle sm =
    scheduler1.create_processor<StateMachineType>(&signalDetector);
 
  // initialize the asynchronous state machine processor
  signalDetector.setProcessorHandle(sm);
 
  scheduler1.initiate_processor(sm);
 
  //create a thread for the asynchronous state machine processor execution
  boost::thread schedulerThread(boost::bind(&sc::fifo_scheduler<>::operator(), &scheduler1, 0));
 
  // use the  main thread for the signal detector component (waiting actionclient requests)
  signalDetector.pollingLoop();
 
  // After polling loop exits (due to shutdown), terminate the scheduler from main thread
  // This is safe to call here (not from signal handler) as we're in the main thread context
  RCLCPP_INFO(rclcpp::get_logger("SMACC"), "Polling loop exited. Terminating scheduler...");
  signalDetector.terminateScheduler();
 
  // Wait for scheduler thread to finish
  RCLCPP_INFO(rclcpp::get_logger("SMACC"), "Waiting for scheduler thread to join...");
  schedulerThread.join();
  RCLCPP_INFO(rclcpp::get_logger("SMACC"), "Scheduler thread terminated. Shutdown complete.");
 
  // Clear global reference
  g_signal_detector = nullptr;
}

References g_signal_detector, onSignalShutdown(), onSigQuit(), smacc2::SignalDetector::pollingLoop(), smacc2::SignalDetector::setProcessorHandle(), and smacc2::SignalDetector::terminateScheduler().

Referenced by smacc2::SmaccStateMachineBase< DerivedStateMachine, InitialStateType >::reset().

Here is the call graph for this function:

Here is the caller graph for this function:

run_async()

template<typename StateMachineType >

SmExecution * smacc2::run_async

(

)

Definition at line 179 of file smacc_signal_detector.hpp.

{
  // Register signal handlers for graceful shutdown
  ::signal(SIGINT, onSignalShutdown);
  ::signal(SIGTERM, onSignalShutdown);
  ::signal(SIGQUIT, onSigQuit);
 
  SmExecution * ret = new SmExecution();
 
  // create the asynchronous state machine scheduler
  ret->scheduler1 = new SmaccFifoScheduler(true);
 
  // create the signalDetector component
  ret->signalDetector = new SignalDetector(ret->scheduler1);
 
  // Store global reference for signal handler access
  g_signal_detector = ret->signalDetector;
 
  // create the asynchronous state machine processor
  ret->sm = ret->scheduler1->create_processor<StateMachineType>(ret->signalDetector);
 
  // initialize the asynchronous state machine processor
  ret->signalDetector->setProcessorHandle(ret->sm);
 
  ret->scheduler1->initiate_processor(ret->sm);
 
  //create a thread for the asynchronous state machine processor execution
  ret->schedulerThread =
    new boost::thread(boost::bind(&sc::fifo_scheduler<>::operator(), ret->scheduler1, NULL));
  ret->signalDetectorLoop =
    new boost::thread(boost::bind(&SignalDetector::pollingLoop, ret->signalDetector));
 
  return ret;
}

References g_signal_detector, onSignalShutdown(), onSigQuit(), smacc2::SignalDetector::pollingLoop(), smacc2::SmExecution::scheduler1, smacc2::SmExecution::schedulerThread, smacc2::SignalDetector::setProcessorHandle(), smacc2::SmExecution::signalDetector, smacc2::SmExecution::signalDetectorLoop, and smacc2::SmExecution::sm.

Here is the call graph for this function:

specificNamedOnExit() [1/3]

template<typename TState , typename TTransitionTagName >

void smacc2::specificNamedOnExit	(	TState &	,
		TTransitionTagName	,
		std::false_type	)

Definition at line 50 of file state_traits.hpp.

{
}

specificNamedOnExit() [2/3]

template<typename TState , typename TTransitionTagName >

void smacc2::specificNamedOnExit	(	TState &	m,
		TTransitionTagName	tn )

Definition at line 55 of file state_traits.hpp.

{
  specificNamedOnExit(
    m, tn,
    std::integral_constant<bool, HasSpecificNamedOnExit<TState, TTransitionTagName>::value>());
}

References specificNamedOnExit().

Here is the call graph for this function:

specificNamedOnExit() [3/3]

template<typename TState , typename TTransitionTagName >

void smacc2::specificNamedOnExit	(	TState &	st,
		TTransitionTagName	tn,
		std::true_type	)

Definition at line 44 of file state_traits.hpp.

{
  st.onExit(tn);
}

Referenced by smacc2::Transition< Event, Destination, Tag, TransitionContext, pTransitionAction >::reactions< State >::react_with_action(), smacc2::Transition< Event, Destination, Tag, TransitionContext, pTransitionAction >::reactions< State >::react_without_action(), and specificNamedOnExit().

Here is the caller graph for this function:

standardOnExit() [1/3]

template<typename TState >

void smacc2::standardOnExit	(	TState &	,
		std::false_type	)

Definition at line 89 of file state_traits.hpp.

{
}

standardOnExit() [2/3]

template<typename TState >

void smacc2::standardOnExit

(

TState &

m

)

Definition at line 94 of file state_traits.hpp.

{
  standardOnExit(m, std::integral_constant<bool, HasStandardOnExit<TState>::value>());
}

References standardOnExit().

Here is the call graph for this function:

standardOnExit() [3/3]

template<typename TState >

void smacc2::standardOnExit	(	TState &	st,
		std::true_type	)

Definition at line 83 of file state_traits.hpp.

{
  st.onExit();
}

Referenced by smacc2::SmaccState< MostDerived, Context, InnerInitial, historyMode >::exit(), and standardOnExit().

Here is the caller graph for this function:

Variable Documentation

g_shutdown_requested

std::atomic< bool > smacc2::g_shutdown_requested {false}

Definition at line 41 of file signal_detector.cpp.

{false};

Referenced by onSignalShutdown().

g_signal_detector

SignalDetector * smacc2::g_signal_detector = nullptr

Definition at line 42 of file signal_detector.cpp.

Referenced by onSignalShutdown(), run(), and run_async().