control_box_rst: corbo::StaticReference Class Reference

Static reference trajectory. More...

#include <reference_trajectory.h>

Inheritance diagram for corbo::StaticReference:

Inheritance graph

[legend]

Public Types
using	Ptr = std::shared_ptr< StaticReference >

Public Types inherited from corbo::ReferenceTrajectoryInterface
using	OutputVector = Eigen::VectorXd

using	Ptr = std::shared_ptr< ReferenceTrajectoryInterface >

Public Member Functions
int	getDimension () const override

ReferenceTrajectoryInterface::Ptr	getInstance () const override

const OutputVector &	getNextSteadyState (const Time &t) override

void	getReference (const Time &, OutputVector &ref) const override

const OutputVector &	getReferenceCached (int) const override

bool	isCached (double, int, Time) const override

bool	isCached (const std::vector< double > &, Time) const override

bool	isStatic () const override

bool	isZero () const override

void	precompute (double, int, Time) override

void	precompute (const std::vector< double > &, Time) override

void	setReference (const Eigen::Ref< const OutputVector > &ref)

	StaticReference ()

	StaticReference (const Eigen::Ref< const OutputVector > &ref)

Public Member Functions inherited from corbo::ReferenceTrajectoryInterface
virtual	~ReferenceTrajectoryInterface ()=default

Private Attributes
OutputVector	_ref

Additional Inherited Members
Static Public Member Functions inherited from corbo::ReferenceTrajectoryInterface
static Factory< ReferenceTrajectoryInterface > &	getFactory ()
	Get access to the associated factory. More...

Detailed Description

Static reference trajectory.

Stores a static reference trajectory containg a single set-point with arbitrary components.

See also: ReferenceTrajectoryInterface ZeroReference

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 112 of file reference_trajectory.h.

Member Typedef Documentation

◆ Ptr

using corbo::StaticReference::Ptr = std::shared_ptr<StaticReference>

Definition at line 115 of file reference_trajectory.h.

Constructor & Destructor Documentation

◆ StaticReference() [1/2]

corbo::StaticReference::StaticReference ( )

inline

Definition at line 117 of file reference_trajectory.h.

◆ StaticReference() [2/2]

corbo::StaticReference::StaticReference ( const Eigen::Ref< const OutputVector > & ref )

inlineexplicit

Definition at line 118 of file reference_trajectory.h.

Member Function Documentation

◆ getDimension()

int corbo::StaticReference::getDimension ( ) const

inlineoverridevirtual

Implements corbo::ReferenceTrajectoryInterface.

Definition at line 124 of file reference_trajectory.h.

◆ getInstance()

ReferenceTrajectoryInterface::Ptr corbo::StaticReference::getInstance ( ) const

inlineoverridevirtual

Implements corbo::ReferenceTrajectoryInterface.

Reimplemented in corbo::ZeroReference.

Definition at line 120 of file reference_trajectory.h.

◆ getNextSteadyState()

const OutputVector& corbo::StaticReference::getNextSteadyState ( const Time & t )

inlineoverridevirtual

Implements corbo::ReferenceTrajectoryInterface.

Definition at line 133 of file reference_trajectory.h.

◆ getReference()

void corbo::StaticReference::getReference	(	const Time &	,
		OutputVector &	ref
	)		const

inlineoverridevirtual

Implements corbo::ReferenceTrajectoryInterface.

Definition at line 129 of file reference_trajectory.h.

◆ getReferenceCached()

const OutputVector& corbo::StaticReference::getReferenceCached ( int ) const

inlineoverridevirtual

Implements corbo::ReferenceTrajectoryInterface.

Definition at line 131 of file reference_trajectory.h.

◆ isCached() [1/2]

bool corbo::StaticReference::isCached	(	double	,
		int	,
		Time
	)		const

inlineoverridevirtual

Implements corbo::ReferenceTrajectoryInterface.

Definition at line 137 of file reference_trajectory.h.

◆ isCached() [2/2]

bool corbo::StaticReference::isCached	(	const std::vector< double > &	,
		Time
	)		const

inlineoverridevirtual

Implements corbo::ReferenceTrajectoryInterface.

Definition at line 138 of file reference_trajectory.h.

◆ isStatic()

bool corbo::StaticReference::isStatic ( ) const

inlineoverridevirtual

Implements corbo::ReferenceTrajectoryInterface.

Definition at line 122 of file reference_trajectory.h.

◆ isZero()

bool corbo::StaticReference::isZero ( ) const

inlineoverridevirtual

Reimplemented from corbo::ReferenceTrajectoryInterface.

Reimplemented in corbo::ZeroReference.

Definition at line 123 of file reference_trajectory.h.

◆ precompute() [1/2]

void corbo::StaticReference::precompute	(	double	,
		int	,
		Time
	)

inlineoverridevirtual

Implements corbo::ReferenceTrajectoryInterface.

Definition at line 126 of file reference_trajectory.h.

◆ precompute() [2/2]

void corbo::StaticReference::precompute	(	const std::vector< double > &	,
		Time
	)

inlineoverridevirtual

Implements corbo::ReferenceTrajectoryInterface.

Definition at line 127 of file reference_trajectory.h.

◆ setReference()

void corbo::StaticReference::setReference ( const Eigen::Ref< const OutputVector > & ref )

inline

Definition at line 135 of file reference_trajectory.h.

Member Data Documentation

◆ _ref

OutputVector corbo::StaticReference::_ref

private

Definition at line 147 of file reference_trajectory.h.

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

reference_trajectory.h

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