#include <BipedalLocomotion/System/Advanceable.h>
template<class _Input, class _Output>
BipedalLocomotion::System::Advanceable class

Basic class that represents a discrete system.

The interface contains method to set inputs and output.

Base classes

template<class _Input>
class InputPort<_Input>
Basic class that represents an input port.
template<class _Output>
class OutputPort<_Output>
Basic class that represents an output port.

Derived classes

template<class Output>
class Source
Source is a template specialization of Advanceable and represents a block that does not contains input.
template<class Output>
class Source
Source is a template specialization of Advanceable and represents a block that does not contains input.
template<class Output>
class Source
Source is a template specialization of Advanceable and represents a block that does not contains input.
template<class Output>
class Source
Source is a template specialization of Advanceable and represents a block that does not contains input.
template<class Output>
class Source
Source is a template specialization of Advanceable and represents a block that does not contains input.
template<class Output>
class Source
Source is a template specialization of Advanceable and represents a block that does not contains input.
template<class Output>
class Source
Source is a template specialization of Advanceable and represents a block that does not contains input.
template<class Output>
class Source
Source is a template specialization of Advanceable and represents a block that does not contains input.
template<class Output>
class Source
Source is a template specialization of Advanceable and represents a block that does not contains input.
template<class Output>
class Source
Source is a template specialization of Advanceable and represents a block that does not contains input.
template<class Output>
class Source
Source is a template specialization of Advanceable and represents a block that does not contains input.
template<class Output>
class Source
Source is a template specialization of Advanceable and represents a block that does not contains input.

Public types

using Input = typename BipedalLocomotion::System::InputPort<_Input>::Input
using Output = typename BipedalLocomotion::System::OutputPort<_Output>::Output

Constructors, destructors, conversion operators

Advanceable() defaulted
Advanceable(const Advanceable&) deleted
Advanceable(Advanceable&&) deleted
~Advanceable() defaulted virtual

Public functions

auto operator=(const Advanceable&) -> Advanceable& deleted
auto operator=(Advanceable&&) -> Advanceable& deleted
auto initialize(std::weak_ptr<const ParametersHandler::IParametersHandler> handler) -> bool virtual
Initialize the advanceable.
auto advance() -> bool pure virtual
Advance the internal state.
auto close() -> bool virtual
Close the Advanceable.

Function documentation

template<class _Input, class _Output>
bool BipedalLocomotion::System::Advanceable<_Input, _Output>::initialize(std::weak_ptr<const ParametersHandler::IParametersHandler> handler) virtual

Initialize the advanceable.

Returns True if the initialization is successfull.

template<class _Input, class _Output>
bool BipedalLocomotion::System::Advanceable<_Input, _Output>::advance() pure virtual

Advance the internal state.

Returns True if the advance is successfull.

This may change the value retrievable from getOutput().

template<class _Input, class _Output>
bool BipedalLocomotion::System::Advanceable<_Input, _Output>::close() virtual

Close the Advanceable.

Returns True if the close is successfull.