Goby3  3.1.5a
2024.05.23
goby::acomms::iridium::fsm::IridiumDriverFSM Struct Reference

#include <goby/acomms/modemdriver/iridium_driver_fsm.h>

Inheritance diagram for goby::acomms::iridium::fsm::IridiumDriverFSM:
boost::statechart::state_machine< IridiumDriverFSM, Active >

Public Member Functions

 IridiumDriverFSM (const goby::acomms::protobuf::DriverConfig &driver_cfg)
 
void buffer_data_out (const goby::acomms::protobuf::ModemTransmission &msg)
 
boost::circular_buffer< std::string > & serial_tx_buffer ()
 
boost::circular_buffer< goby::acomms::protobuf::ModemTransmission > & received ()
 
boost::circular_buffer< goby::acomms::protobuf::ModemTransmission > & data_out ()
 
const goby::acomms::protobuf::DriverConfigdriver_cfg () const
 
const goby::acomms::iridium::protobuf::Configiridium_driver_cfg () const
 
const std::string & glog_ir_group () const
 
const CIEVData & ciev_data () const
 
void parse_ciev (const std::string &ciev)
 
- Public Member Functions inherited from boost::statechart::state_machine< IridiumDriverFSM, Active >
void initiate ()
 
void terminate ()
 
bool terminated () const
 
void process_event (const event_base_type &evt)
 
Target state_cast () const
 
Target state_downcast () const
 
state_iterator state_begin () const
 
state_iterator state_end () const
 
void unconsumed_event (const event_base &)
 
void clear_shallow_history ()
 
void clear_deep_history ()
 
const event_base_typetriggering_event () const
 
void post_event_impl (const event_base_ptr_type &pEvent)
 
void post_event_impl (const event_base &evt)
 
detail::reaction_result react_impl (const event_base_type &, typename rtti_policy_type::id_type)
 
void exit_impl (inner_context_ptr_type &, typename state_base_type::node_state_base_ptr_type &, bool)
 
void set_outermost_unstable_state (typename state_base_type::node_state_base_ptr_type &pOutermostUnstableState)
 
Context & context ()
 
const Context & context () const
 
outermost_context_typeoutermost_context ()
 
const outermost_context_typeoutermost_context () const
 
outermost_context_base_typeoutermost_context_base ()
 
const outermost_context_base_typeoutermost_context_base () const
 
void terminate_as_reaction (state_base_type &theState)
 
void terminate_as_part_of_transit (state_base_type &theState)
 
void terminate_as_part_of_transit (state_machine &)
 
void add (const intrusive_ptr< State > &pState)
 
void add_inner_state (detail::orthogonal_position_type position, state_base_type *pOutermostState)
 
void remove_inner_state (detail::orthogonal_position_type position)
 
void release_events ()
 
void store_shallow_history ()
 
void construct_with_shallow_history (const typename DefaultState::context_ptr_type &pContext)
 
void store_deep_history ()
 
void construct_with_deep_history (const typename DefaultState::context_ptr_type &pContext)
 

Additional Inherited Members

- Public Types inherited from boost::statechart::state_machine< IridiumDriverFSM, Active >
typedef std::allocator< none > allocator_type
 
typedef detail::rtti_policy rtti_policy_type
 
typedef event_base event_base_type
 
typedef intrusive_ptr< const event_base_typeevent_base_ptr_type
 
typedef detail::state_base< allocator_type, rtti_policy_typestate_base_type
 
typedef IridiumDriverFSM inner_context_type
 
typedef mpl::integral_c< detail::orthogonal_position_type, 0 > inner_orthogonal_position
 
typedef mpl::integral_c< detail::orthogonal_position_type, 1 > no_of_orthogonal_regions
 
typedef IridiumDriverFSM outermost_context_type
 
typedef state_machine outermost_context_base_type
 
typedef state_machineinner_context_ptr_type
 
typedef state_base_type::node_state_base_ptr_type node_state_base_ptr_type
 
typedef state_base_type::leaf_state_ptr_type leaf_state_ptr_type
 
typedef state_base_type::state_list_type state_list_type
 
typedef mpl::clear< mpl::list<> >::type context_type_list
 
typedef mpl::bool_< false > shallow_history
 
typedef mpl::bool_< false > deep_history
 
typedef mpl::bool_< false > inherited_deep_history
 
- Protected Member Functions inherited from boost::statechart::state_machine< IridiumDriverFSM, Active >
 state_machine ()
 
virtual ~state_machine ()
 
void post_event (const event_base_ptr_type &pEvent)
 
void post_event (const event_base &evt)
 

Detailed Description

Definition at line 201 of file iridium_driver_fsm.h.

Constructor & Destructor Documentation

◆ IridiumDriverFSM()

goby::acomms::iridium::fsm::IridiumDriverFSM::IridiumDriverFSM ( const goby::acomms::protobuf::DriverConfig driver_cfg)
inline

Definition at line 211 of file iridium_driver_fsm.h.

Member Function Documentation

◆ buffer_data_out()

void goby::acomms::iridium::fsm::IridiumDriverFSM::buffer_data_out ( const goby::acomms::protobuf::ModemTransmission msg)

◆ ciev_data()

const CIEVData& goby::acomms::iridium::fsm::IridiumDriverFSM::ciev_data ( ) const
inline

Definition at line 246 of file iridium_driver_fsm.h.

◆ data_out()

boost::circular_buffer<goby::acomms::protobuf::ModemTransmission>& goby::acomms::iridium::fsm::IridiumDriverFSM::data_out ( )
inline

Definition at line 233 of file iridium_driver_fsm.h.

◆ driver_cfg()

const goby::acomms::protobuf::DriverConfig& goby::acomms::iridium::fsm::IridiumDriverFSM::driver_cfg ( ) const
inline

Definition at line 238 of file iridium_driver_fsm.h.

◆ glog_ir_group()

const std::string& goby::acomms::iridium::fsm::IridiumDriverFSM::glog_ir_group ( ) const
inline

Definition at line 244 of file iridium_driver_fsm.h.

◆ iridium_driver_cfg()

const goby::acomms::iridium::protobuf::Config& goby::acomms::iridium::fsm::IridiumDriverFSM::iridium_driver_cfg ( ) const
inline

Definition at line 239 of file iridium_driver_fsm.h.

◆ parse_ciev()

void goby::acomms::iridium::fsm::IridiumDriverFSM::parse_ciev ( const std::string &  ciev)

◆ received()

boost::circular_buffer<goby::acomms::protobuf::ModemTransmission>& goby::acomms::iridium::fsm::IridiumDriverFSM::received ( )
inline

Definition at line 227 of file iridium_driver_fsm.h.

◆ serial_tx_buffer()

boost::circular_buffer<std::string>& goby::acomms::iridium::fsm::IridiumDriverFSM::serial_tx_buffer ( )
inline

Definition at line 224 of file iridium_driver_fsm.h.


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