opyn::OutputExtractor Class Reference

#include <output_extractor.h>

Inheritance diagram for opyn::OutputExtractor:

Public Member Functions
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

Protected Member Functions
	OutputExtractor ()=default
	OutputExtractor (const OutputExtractor &)=default
	OutputExtractor (OutputExtractor &&) noexcept=default
OutputExtractor &	operator= (const OutputExtractor &)=default
OutputExtractor &	operator= (OutputExtractor &&) noexcept=default

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

Friends
bool	operator== (const OutputExtractor &lhs, const OutputExtractor &rhs)

Constructor & Destructor Documentation

OutputExtractor() [1/3]

opyn::OutputExtractor::OutputExtractor ( )

protecteddefault

OutputExtractor() [2/3]

opyn::OutputExtractor::OutputExtractor ( const OutputExtractor &  )

protecteddefault

OutputExtractor() [3/3]

opyn::OutputExtractor::OutputExtractor ( OutputExtractor &&  )

protecteddefaultnoexcept

~OutputExtractor()

virtual opyn::OutputExtractor::~OutputExtractor ( )

virtualdefaultnoexcept

Member Function Documentation

equals()

bool opyn::OutputExtractor::equals ( const OutputExtractor &  other ) const

inline

getDescription()

osc::CStringView opyn::OutputExtractor::getDescription ( ) const

inline

getHash()

size_t opyn::OutputExtractor::getHash ( ) const

inline

getName()

osc::CStringView opyn::OutputExtractor::getName ( ) const

inline

getOutputType()

OutputExtractorDataType opyn::OutputExtractor::getOutputType ( ) const

inline

getOutputValueExtractor()

OutputValueExtractor opyn::OutputExtractor::getOutputValueExtractor ( const OpenSim::Component &  component ) const

inline

getValue()

template<typename T >
requires std::constructible_from<T, osc::Variant&&>

T opyn::OutputExtractor::getValue ( const OpenSim::Component &  component, const opyn::StateViewWithMetadata &  state  ) const

inline

getValues()

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 opyn::OutputExtractor::getValues ( const OpenSim::Component &  component, const R &  states, Consumer &&  consumer  ) const

inline

implEquals()

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

privatepure virtual

Implemented in opyn::ComponentOutputExtractor, opyn::ForceRecordOutputExtractor, opyn::IntegratorOutputExtractor, opyn::MultiBodySystemOutputExtractor, opyn::ConcatenatingOutputExtractor, and opyn::ConstantOutputExtractor.

implGetDescription()

virtual osc::CStringView opyn::OutputExtractor::implGetDescription ( ) const

privatepure virtual

Implemented in opyn::ComponentOutputExtractor, opyn::ForceRecordOutputExtractor, opyn::IntegratorOutputExtractor, opyn::MultiBodySystemOutputExtractor, opyn::ConcatenatingOutputExtractor, and opyn::ConstantOutputExtractor.

implGetHash()

virtual size_t opyn::OutputExtractor::implGetHash ( ) const

privatepure virtual

Implemented in opyn::ComponentOutputExtractor, opyn::ForceRecordOutputExtractor, opyn::IntegratorOutputExtractor, opyn::MultiBodySystemOutputExtractor, opyn::ConcatenatingOutputExtractor, and opyn::ConstantOutputExtractor.

implGetName()

virtual osc::CStringView opyn::OutputExtractor::implGetName ( ) const

privatepure virtual

Implemented in opyn::ComponentOutputExtractor, opyn::ForceRecordOutputExtractor, opyn::IntegratorOutputExtractor, opyn::MultiBodySystemOutputExtractor, opyn::ConcatenatingOutputExtractor, and opyn::ConstantOutputExtractor.

implGetOutputType()

virtual OutputExtractorDataType opyn::OutputExtractor::implGetOutputType ( ) const

privatepure virtual

Implemented in opyn::ComponentOutputExtractor, opyn::ForceRecordOutputExtractor, opyn::MultiBodySystemOutputExtractor, opyn::ConcatenatingOutputExtractor, opyn::ConstantOutputExtractor, and opyn::IntegratorOutputExtractor.

implGetOutputValueExtractor()

virtual OutputValueExtractor opyn::OutputExtractor::implGetOutputValueExtractor ( const OpenSim::Component &  ) const

privatepure virtual

Implemented in opyn::ComponentOutputExtractor, opyn::ForceRecordOutputExtractor, opyn::IntegratorOutputExtractor, opyn::MultiBodySystemOutputExtractor, opyn::ConcatenatingOutputExtractor, and opyn::ConstantOutputExtractor.

operator=() [1/2]

OutputExtractor & opyn::OutputExtractor::operator= ( const OutputExtractor &  )

protecteddefault

operator=() [2/2]

OutputExtractor & opyn::OutputExtractor::operator= ( OutputExtractor &&  )

protecteddefaultnoexcept

slurpValues()

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 > opyn::OutputExtractor::slurpValues ( const OpenSim::Component &  component, const R &  states  ) const

inline

Friends And Related Symbol Documentation

operator==

bool operator== ( const OutputExtractor &  lhs, const OutputExtractor &  rhs  )

friend

---

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

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