Class sdm::BaseObservation

template <typename TObservation typename TObservation>

Class List > sdm > BaseObservation

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

  • #include <base_observation.hpp>

Inherits the following classes: sdm::Observation

Public Functions

Type Name
BaseObservation ()
BaseObservation (const TObservation & item)
virtual TObservation getObservation () const
Get the data corresponding to the stored observation.
virtual void setObservation (const TObservation & state)
Set the data corresponding to the stored observation.
virtual std::string str () const
Get a string describing the current item.
virtual ~BaseObservation ()

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
TObservation observation_

Detailed Description

Template parameters:

  • TObservation the type of data used for the observation.

This class can be used to instantiate an observation represented by any type.

BaseObservation<char> obs('a'), obs2('b'); // Instanciate an observation stored as a character.   
BaseObservation<float> float_obs(0.0), float_obs2(0.1); // Instanciate an observation stored as a float.   

Public Functions Documentation

function BaseObservation [1/2]

sdm::BaseObservation::BaseObservation () 

function BaseObservation [2/2]

sdm::BaseObservation::BaseObservation (
    const TObservation & item
) 

function getObservation

virtual TObservation sdm::BaseObservation::getObservation () const

Returns:

the data

function setObservation

virtual void sdm::BaseObservation::setObservation (
    const TObservation & state
) 

Parameters:

  • state the data

function str

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

Returns:

std::string the description of the item

Implements sdm::Observation::str

function ~BaseObservation

virtual sdm::BaseObservation::~BaseObservation () 

Protected Attributes Documentation

variable observation_

TObservation sdm::BaseObservation< TObservation >::observation_;

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