statemachine::State Class Reference

The abstract state class. All states inherit from this class. More...

#include <State.hpp>

Inheritance diagram for statemachine::State:

Public Member Functions
	State (States eState)
	Construct a new State object.
virtual	~State ()=default
	Destroy the State object.
virtual States	TriggerEvent (Event eEvent)=0
	Trigger an event in the state machine. Returns the next state.
virtual void	Run ()=0
	Run the state machine. Returns the next state.
States	GetState () const
	Accessor for the State private member.
virtual std::string	ToString () const
	Accessor for the State private member. Returns the state as a string.
virtual bool	operator== (const State &other) const
	Checks to see if the current state is equal to the passed state.
virtual bool	operator!= (const State &other) const
	Checks to see if the current state is not equal to the passed state.

Protected Member Functions
virtual void	Start ()
	This method is called when the state is first started. It is used to initialize the state.
virtual void	Exit ()
	This method is called when the state is exited. It is used to clean up the state.

Private Attributes
States	m_eState
std::string	m_szStateName

Detailed Description

The abstract state class. All states inherit from this class.

Author

Eli Byrd (edbgk.nosp@m.k@ms.nosp@m.t.edu)

Date

2024-01-18

Constructor & Destructor Documentation

State()

statemachine::State::State ( States  eState )

inline

Construct a new State object.

Parameters

eState

- The state to start in.

Author

Eli Byrd (edbgk.nosp@m.k@ms.nosp@m.t.edu)

Date

2024-01-18

            {
                // Set State
                m_eState = eState;
 
                // Set State Name
                m_szStateName = StateToString(m_eState);
 
                // Start the State
                Start();
            }

Here is the call graph for this function:

~State()

virtual statemachine::State::~State ( )

virtualdefault

Destroy the State object.

Author

Eli Byrd (edbgk.nosp@m.k@ms.nosp@m.t.edu)

Date

2024-01-17

Member Function Documentation

Start()

virtual void statemachine::State::Start ( )

inlineprotectedvirtual

This method is called when the state is first started. It is used to initialize the state.

Author

Eli Byrd (edbgk.nosp@m.k@ms.nosp@m.t.edu)

Date

2024-01-17

Reimplemented in statemachine::ApproachingMarkerState, statemachine::ApproachingObjectState, statemachine::IdleState, statemachine::NavigatingState, statemachine::ReversingState, statemachine::SearchPatternState, statemachine::StuckState, statemachine::VerifyingMarkerState, statemachine::VerifyingObjectState, and statemachine::VerifyingPositionState.

{ return; }

Here is the caller graph for this function:

Exit()

virtual void statemachine::State::Exit ( )

inlineprotectedvirtual

This method is called when the state is exited. It is used to clean up the state.

Author

Eli Byrd (edbgk.nosp@m.k@ms.nosp@m.t.edu)

Date

2024-01-17

Reimplemented in statemachine::ApproachingMarkerState, statemachine::ApproachingObjectState, statemachine::IdleState, statemachine::NavigatingState, statemachine::ReversingState, statemachine::SearchPatternState, statemachine::StuckState, statemachine::VerifyingMarkerState, statemachine::VerifyingObjectState, and statemachine::VerifyingPositionState.

{ return; }

TriggerEvent()

virtual States statemachine::State::TriggerEvent ( Event  eEvent )

pure virtual

Trigger an event in the state machine. Returns the next state.

Parameters

eEvent

- The event to trigger.

Returns

std::shared_ptr<State> - The next state.

Author

Eli Byrd (edbgk.nosp@m.k@ms.nosp@m.t.edu)

Date

2024-01-17

Implemented in statemachine::ApproachingMarkerState, statemachine::ApproachingObjectState, statemachine::IdleState, statemachine::NavigatingState, statemachine::ReversingState, statemachine::SearchPatternState, statemachine::StuckState, statemachine::VerifyingMarkerState, statemachine::VerifyingObjectState, and statemachine::VerifyingPositionState.

Run()

virtual void statemachine::State::Run ( )

pure virtual

Run the state machine. Returns the next state.

Author

Eli Byrd (edbgk.nosp@m.k@ms.nosp@m.t.edu)

Date

2024-01-17

Implemented in statemachine::ApproachingMarkerState, statemachine::ApproachingObjectState, statemachine::IdleState, statemachine::NavigatingState, statemachine::ReversingState, statemachine::SearchPatternState, statemachine::StuckState, statemachine::VerifyingMarkerState, statemachine::VerifyingObjectState, and statemachine::VerifyingPositionState.

GetState()

States statemachine::State::GetState ( ) const

inline

Accessor for the State private member.

Returns

States - The current state.

Author

Eli Byrd (edbgk.nosp@m.k@ms.nosp@m.t.edu)

Date

2024-01-17

{ return m_eState; }

ToString()

virtual std::string statemachine::State::ToString ( ) const

inlinevirtual

Accessor for the State private member. Returns the state as a string.

Returns

std::string - The current state as a string.

Author

Eli Byrd (edbgk.nosp@m.k@ms.nosp@m.t.edu)

Date

2024-01-17

{ return m_szStateName; }

Here is the caller graph for this function:

operator==()

virtual bool statemachine::State::operator== ( const State &  other ) const

inlinevirtual

Checks to see if the current state is equal to the passed state.

Parameters

other

- The state to compare to.

Returns

true - The states are equal.

false - The states are not equal.

Author

Eli Byrd (edbgk.nosp@m.k@ms.nosp@m.t.edu)

Date

2024-01-17

{ return ToString() == other.ToString(); }

Here is the call graph for this function:

Here is the caller graph for this function:

operator!=()

virtual bool statemachine::State::operator!= ( const State &  other ) const

inlinevirtual

Checks to see if the current state is not equal to the passed state.

Parameters

other

- The state to compare to.

Returns

true - The states are not equal.

false - The states are equal.

Author

Eli Byrd (edbgk.nosp@m.k@ms.nosp@m.t.edu)

Date

2024-01-17

{ return !operator==(other); }

Here is the call graph for this function:

---

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

• src/interfaces/State.hpp