Static Public Member Functions | List of all members
packml_sm::PackmlStateMachineSingleCycle Class Reference

#include <packml_state_machine_single_cycle.h>

Inheritance diagram for packml_sm::PackmlStateMachineSingleCycle:
Inheritance graph
[legend]

Static Public Member Functions

static std::shared_ptr< PackmlStateMachineSingleCyclespawn ()
 

Additional Inherited Members

- Public Member Functions inherited from packml_sm::PackmlStateMachine< PackmlTransitionsSingleCycle >
virtual bool activate () override
 Override to handle activate command. More...
 
virtual bool deactivate () override
 Override to handle deactivate command. More...
 
virtual bool isActive () override
 Override to provide an accessor to whether the state machine is currently active. More...
 
virtual bool setAborting (std::function< int()> state_method) override
 Override to handle setting the aborting state method. More...
 
virtual bool setClearing (std::function< int()> state_method) override
 Override to handle setting the clearing state method. More...
 
virtual bool setCompleting (std::function< int()> state_method) override
 Override to handle setting the completing state method. More...
 
virtual bool setExecute (std::function< int()> state_method) override
 Override to handle setting the execute state method. More...
 
virtual bool setHolding (std::function< int()> state_method) override
 Override to handle setting the holding state method. More...
 
virtual bool setResetting (std::function< int()> state_method) override
 Override to handle setting the resetting state method. More...
 
virtual bool setStarting (std::function< int()> state_method) override
 Override to handle setting the starting state method. More...
 
virtual bool setStopping (std::function< int()> state_method) override
 Override to handle setting the stopping state method. More...
 
virtual bool setSuspending (std::function< int()> state_method) override
 Override to handle setting the suspending state method. More...
 
virtual bool setUnholding (std::function< int()> state_method) override
 Override to handle setting unholding state method. More...
 
virtual bool setUnsuspending (std::function< int()> state_method) override
 Override to handle setting the un-suspending state method. More...
 
virtual ~PackmlStateMachine ()
 
- Public Member Functions inherited from packml_sm::AbstractStateMachine
virtual bool abort ()
 Call to send the abort command. More...
 
 AbstractStateMachine ()
 Constructor for AbstractStateMachine. More...
 
virtual bool clear ()
 Call to send the clear command. More...
 
double getAbortedTime ()
 Accessor for the duration spent in aborted. More...
 
double getAbortingTime ()
 Accessor for the duration spent in aborting. More...
 
double getClearingTime ()
 Accessor for the duration spent in clearing. More...
 
double getCompleteTime ()
 Accessor for the duration spent in complete. More...
 
StatesEnum getCurrentState () const
 Accessor for the current state. More...
 
void getCurrentStatSnapshot (PackmlStatsSnapshot &snapshot_out)
 Fills the reference variable with the current stats snapshot. More...
 
double getExecuteTime ()
 Accessor for the duration spent in execute. More...
 
double getHeldTime ()
 Accessor for the duration spent in held. More...
 
double getHoldingTime ()
 Accessor for the duration spent in holding. More...
 
double getIdleTime ()
 Accessor for the duration spent in idle time. More...
 
double getResettingTime ()
 Accessor for the duration spent in resetting. More...
 
double getStartingTime ()
 Accessor for the duration spent in starting. More...
 
double getStoppedTime ()
 Accessor for the duration spent in stopped. More...
 
double getStoppingTime ()
 Accessor for the duration spent in stopping. More...
 
double getSuspendedTime ()
 Accessor for the duration spent in suspended. More...
 
double getSuspendingTime ()
 Accessor for the duration spent in suspending. More...
 
double getUnholdingTime ()
 Accessor for the duration spent in unholding. More...
 
double getUnsuspendingTime ()
 Accessor for the duration spent in unsuspending. More...
 
virtual bool hold ()
 Call to send the hold command. More...
 
void incrementErrorStatItem (int16_t id, int32_t count, double duration)
 Call to increment or add a specific Itemized error stat. More...
 
void incrementFailureCount ()
 Call to increment the failed operation count. More...
 
void incrementQualityStatItem (int16_t id, int32_t count, double duration)
 Call to increment or add a specific Itemized quality stat. More...
 
void incrementSuccessCount ()
 Call to increment the successful operation count. More...
 
virtual bool reset ()
 Call to send the reset command. More...
 
void resetStats ()
 Reset all of the tracked states. More...
 
void setIdealCycleTime (float ideal_cycle_time)
 Sets the ideal cycle time in operations per second. More...
 
virtual bool start ()
 Call to send the start command. More...
 
virtual bool stop ()
 Call to send the stop command. More...
 
virtual bool suspend ()
 Call to send the suspend command. More...
 
virtual bool unhold ()
 Call to send the unhold command. More...
 
virtual bool unsuspend ()
 Call to send the unsuspend command. More...
 
virtual ~AbstractStateMachine ()
 Destructor for AbstractStateMachine. More...
 
- Public Attributes inherited from packml_sm::AbstractStateMachine
EventHandler< AbstractStateMachine, StateChangedEventArgsstateChangedEvent
 
- Protected Member Functions inherited from packml_sm::PackmlStateMachine< PackmlTransitionsSingleCycle >
virtual void _abort () override
 Override to call implementations version of the abort command. More...
 
virtual void _clear () override
 Override to call implementations version of clear command. More...
 
virtual void _hold () override
 Override to call implementations version of the hold command. More...
 
virtual void _reset () override
 Override to call implementations version of the reset command. More...
 
virtual void _start () override
 Override to call implementations version of start command. More...
 
virtual void _stop () override
 Override to call implementations version of the stop command. More...
 
virtual void _suspend () override
 Override to call implementations version of the suspend command. More...
 
virtual void _unhold () override
 Override to call implementations version of the unhold command. More...
 
virtual void _unsuspend () override
 Override to call implementations version of the unsuspend command. More...
 
 PackmlStateMachine ()
 
- Protected Member Functions inherited from packml_sm::AbstractStateMachine
void invokeStateChangedEvent (const std::string &name, StatesEnum value)
 Call to invoke a state changed event. More...
 

Detailed Description

Definition at line 25 of file packml_state_machine_single_cycle.h.

Member Function Documentation

static std::shared_ptr<PackmlStateMachineSingleCycle> packml_sm::PackmlStateMachineSingleCycle::spawn ( )
inlinestatic

Definition at line 28 of file packml_state_machine_single_cycle.h.


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


packml_sm
Author(s): Shaun Edwards
autogenerated on Fri Jul 12 2019 03:30:55