Public Member Functions | List of all members
corbo::FullStateSystemOutput Class Reference

Return full state vector as system output. More...

#include <output_function_interface.h>

Inheritance diagram for corbo::FullStateSystemOutput:
Inheritance graph
[legend]

Public Member Functions

Ptr getInstance () const override
 Return a newly created shared instance of the implemented class. More...
 
int getOutputDimension () const override
 Get dimension of the system output y. More...
 
void output (const StateVector &x, OutputVector &y) override
 Evaluate the system output equation. More...
 
- Public Member Functions inherited from corbo::SystemOutputInterface
virtual void reset ()
 
virtual ~SystemOutputInterface ()=default
 Default destructor. More...
 

Additional Inherited Members

- Public Types inherited from corbo::SystemOutputInterface
using OutputVector = Eigen::VectorXd
 
using Ptr = std::shared_ptr< SystemOutputInterface >
 
using StateVector = Eigen::VectorXd
 

Detailed Description

Return full state vector as system output.

This output function is defined as $ y = x $.

See also
SystemDynamicsInterface
Author
Christoph Rösmann (chris.nosp@m.toph.nosp@m..roes.nosp@m.mann.nosp@m.@tu-d.nosp@m.ortm.nosp@m.und.d.nosp@m.e)

Definition at line 115 of file output_function_interface.h.

Member Function Documentation

◆ getInstance()

Ptr corbo::FullStateSystemOutput::getInstance ( ) const
inlineoverridevirtual

Return a newly created shared instance of the implemented class.

Implements corbo::SystemOutputInterface.

Definition at line 119 of file output_function_interface.h.

◆ getOutputDimension()

int corbo::FullStateSystemOutput::getOutputDimension ( ) const
inlineoverridevirtual

Get dimension of the system output y.

Implements corbo::SystemOutputInterface.

Definition at line 122 of file output_function_interface.h.

◆ output()

void corbo::FullStateSystemOutput::output ( const StateVector x,
OutputVector y 
)
inlineoverridevirtual

Evaluate the system output equation.

This method defines the mapping $ c : \mathbb{R}^p \to \mathbb{R}^q $ with $ p $ as the dimension of the state vector x and $ q $ the dimension of the system output y.

Parameters
[in]xState vector [SystemDynamicsInterface::getStateDimension x 1]
[out]yOutput vector [getOutputDimension() x 1]

Implements corbo::SystemOutputInterface.

Definition at line 124 of file output_function_interface.h.


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


control_box_rst
Author(s): Christoph Rösmann
autogenerated on Mon Feb 28 2022 22:08:02