opyn::IntegratorOutputExtractor Class Reference

#include <integrator_output_extractor.h>

Inheritance diagram for opyn::IntegratorOutputExtractor:

Collaboration diagram for opyn::IntegratorOutputExtractor:

Public Types
using	ExtractorFn = float(*)(const SimTK::Integrator &)

Public Member Functions
	IntegratorOutputExtractor (std::string_view name, std::string_view description, ExtractorFn extractor)
osc::UID	getAuxiliaryDataID () const
ExtractorFn	getExtractorFunction () const
Public Member Functions inherited from opyn::OutputExtractor
virtual	~OutputExtractor () noexcept=default
osc::CStringView	getName () const
osc::CStringView	getDescription () const
OutputExtractorDataType	getOutputType () const
OutputValueExtractor	getOutputValueExtractor (const OpenSim::Component &component) const
template<typename T > requires std::constructible_from<T, osc::Variant&&>
T	getValue (const OpenSim::Component &component, const opyn::StateViewWithMetadata &state) const
template<typename T , std::ranges::forward_range R, std::invocable< T > Consumer> requires ( std::constructible_from<T, osc::Variant&&> and std::convertible_to<std::ranges::range_value_t<R>, const opyn::StateViewWithMetadata&> )
void	getValues (const OpenSim::Component &component, const R &states, Consumer &&consumer) const
template<typename T , std::ranges::forward_range R> requires ( std::constructible_from<T, osc::Variant&&> and std::convertible_to<std::ranges::range_value_t<R>, const opyn::StateViewWithMetadata&> )
std::vector< T >	slurpValues (const OpenSim::Component &component, const R &states) const
size_t	getHash () const
bool	equals (const OutputExtractor &other) const

Private Member Functions
osc::CStringView	implGetName () const final
osc::CStringView	implGetDescription () const final
OutputExtractorDataType	implGetOutputType () const override
OutputValueExtractor	implGetOutputValueExtractor (const OpenSim::Component &) const final
size_t	implGetHash () const final
bool	implEquals (const OutputExtractor &) const final

Additional Inherited Members
Protected Member Functions inherited from opyn::OutputExtractor
	OutputExtractor ()=default
	OutputExtractor (const OutputExtractor &)=default
	OutputExtractor (OutputExtractor &&) noexcept=default
OutputExtractor &	operator= (const OutputExtractor &)=default
OutputExtractor &	operator= (OutputExtractor &&) noexcept=default

Member Typedef Documentation

ExtractorFn

using opyn::IntegratorOutputExtractor::ExtractorFn = float (*)(const SimTK::Integrator&)

Constructor & Destructor Documentation

IntegratorOutputExtractor()

opyn::IntegratorOutputExtractor::IntegratorOutputExtractor ( std::string_view  name, std::string_view  description, ExtractorFn  extractor  )

inline

Member Function Documentation

getAuxiliaryDataID()

osc::UID opyn::IntegratorOutputExtractor::getAuxiliaryDataID ( ) const

inline

getExtractorFunction()

ExtractorFn opyn::IntegratorOutputExtractor::getExtractorFunction ( ) const

inline

implEquals()

bool opyn::IntegratorOutputExtractor::implEquals ( const OutputExtractor &  ) const

finalprivatevirtual

Implements opyn::OutputExtractor.

implGetDescription()

osc::CStringView opyn::IntegratorOutputExtractor::implGetDescription ( ) const

inlinefinalprivatevirtual

Implements opyn::OutputExtractor.

implGetHash()

size_t opyn::IntegratorOutputExtractor::implGetHash ( ) const

finalprivatevirtual

Implements opyn::OutputExtractor.

implGetName()

osc::CStringView opyn::IntegratorOutputExtractor::implGetName ( ) const

inlinefinalprivatevirtual

Implements opyn::OutputExtractor.

implGetOutputType()

OutputExtractorDataType opyn::IntegratorOutputExtractor::implGetOutputType ( ) const

inlineoverrideprivatevirtual

Implements opyn::OutputExtractor.

implGetOutputValueExtractor()

OutputValueExtractor opyn::IntegratorOutputExtractor::implGetOutputValueExtractor ( const OpenSim::Component &  ) const

finalprivatevirtual

Implements opyn::OutputExtractor.

---

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

• /home/adam/Desktop/opensim-creator/third_party/opynsim/libopynsim/documents/output_extractors/integrator_output_extractor.h