Class sdm::BaseState

template <typename TState>

Class List > sdm > BaseState

A base class inheriting from the State interface.More...

• #include <base_state.hpp>

Inherits the following classes: sdm::State

Public Functions

Type	Name
	BaseState ()
	BaseState (const TState & item)
virtual TState	getState () const Get the data corresponding to the stored state.
virtual TypeState	getTypeState () const
virtual bool	operator== (const BaseState & other) const
virtual void	setState (const TState & state) Set the data corresponding to the stored state.
virtual std::string	str () const Get a string describing the current item.
virtual	~BaseState ()

Public Functions inherited from sdm::State

See sdm::State

Type	Name
virtual TypeState	getTypeState () const
virtual size_t	hash () const Get the hash of the state. The hash is used in tabular value functions in order to compare efficiently two states. This function must be reimplemented in inherited classes.
virtual bool	operator== (const std::shared_ptr< State > & other) const Check equality between two states. This function must be implemented in inherited classes.
virtual std::string	str () const = 0 Get a string describing the current item.
virtual std::shared_ptr< BeliefInterface >	toBelief () Cast the state into a belief.
virtual std::shared_ptr< HistoryInterface >	toHistory () Cast the state into a history.
virtual std::shared_ptr< OccupancyStateInterface >	toOccupancyState () Cast the state into an occupancy state.
virtual std::shared_ptr< BaseSerialInterface >	toSerial () Cast the state into a serial interface.
virtual std::shared_ptr< SerialOccupancyInterface >	toSerialOccupancyState () Cast the state into a serial occupancy state.
virtual	~State ()

Public Functions inherited from sdm::Observation

See sdm::Observation

Type	Name
virtual std::string	str () const = 0 Get a string describing the current item.
virtual	~Observation ()

Public Functions inherited from sdm::Item

See sdm::Item

Type	Name
virtual std::shared_ptr< Item >	getPointer () Get the shared_ptr on current (this) item.
virtual bool	isBaseItem ()
virtual std::string	str () const = 0 Get a string describing the current item.
std::shared_ptr< T >	to ()
virtual std::shared_ptr< Action >	toAction () Cast the item into a pointer on action.
virtual std::shared_ptr< Item >	toItem () Cast the item into a pointer on item.
virtual std::shared_ptr< Observation >	toObservation () Cast the item into a pointer on observation.
virtual std::shared_ptr< State >	toState () Cast the item into a pointer on state.

Public Functions inherited from std::inheritable_enable_shared_from_this

See std::inheritable_enable_shared_from_this

Type	Name
std::shared_ptr< Down >	downcasted_shared_from_this ()
std::shared_ptr< T >	shared_from_this ()

Public Functions inherited from std::MultipleInheritableEnableSharedFromThis

See std::MultipleInheritableEnableSharedFromThis

Type	Name
virtual	~MultipleInheritableEnableSharedFromThis ()

Protected Attributes

Type	Name
TState	state_

Detailed Description

Template parameters:

• TState the type of data used for the state.

This class can be used to instantiate a state represented by any type.

BaseState<char> state('a'), state2('b'); // Instanciate a state stored as a character.   
BaseState<float> float_state(0.0), float_state2(0.1); // Instanciate a state stored as a float.   

Public Functions Documentation

function BaseState [1/2]

sdm::BaseState::BaseState () 

function BaseState [2/2]

sdm::BaseState::BaseState (
    const TState & item
) 

function getState

virtual TState sdm::BaseState::getState () const

Returns:

the data

function getTypeState

virtual TypeState sdm::BaseState::getTypeState () const

Implements sdm::State::getTypeState

function operator==

virtual bool sdm::BaseState::operator== (
    const BaseState & other
) const

function setState

virtual void sdm::BaseState::setState (
    const TState & state
) 

Parameters:

• state the data

function str

virtual std::string sdm::BaseState::str () const

Returns:

std::string the description of the item

Implements sdm::State::str

function ~BaseState

virtual sdm::BaseState::~BaseState () 

Protected Attributes Documentation

variable state_

TState sdm::BaseState< TState >::state_;

---

The documentation for this class was generated from the following file src/sdm/core/state/base_state.hpp