opynsim
Unofficial C++ Documentation
Loading...
Searching...
No Matches
Public Member Functions | Friends | List of all members
opyn::SharedOutputExtractor Class Referencefinal

#include <shared_output_extractor.h>

Public Member Functions

template<typename ConcreteOutputExtractor >
 SharedOutputExtractor (ConcreteOutputExtractor &&output)
 
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&&>
getValue (const OpenSim::Component &component, const StateViewWithMetadata &state) 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 StateViewWithMetadata&> )
void getValues (const OpenSim::Component &component, const R &states, const std::function< void(T)> &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 StateViewWithMetadata&> )
std::vector< T > slurpValues (const OpenSim::Component &component, const R &states) const
 
size_t getHash () const
 
bool equals (const OutputExtractor &other) const
 
 operator const OutputExtractor & () const
 
const OutputExtractorgetInner () const
 

Friends

struct std::hash< SharedOutputExtractor >
 
bool operator== (const SharedOutputExtractor &lhs, const SharedOutputExtractor &rhs)
 
std::string to_string (const SharedOutputExtractor &)
 

Constructor & Destructor Documentation

◆ SharedOutputExtractor()

template<typename ConcreteOutputExtractor >
opyn::SharedOutputExtractor::SharedOutputExtractor ( ConcreteOutputExtractor &&  output)
inlineexplicit

Member Function Documentation

◆ equals()

bool opyn::SharedOutputExtractor::equals ( const OutputExtractor other) const
inline

◆ getDescription()

osc::CStringView opyn::SharedOutputExtractor::getDescription ( ) const
inline

◆ getHash()

size_t opyn::SharedOutputExtractor::getHash ( ) const
inline

◆ getInner()

const OutputExtractor & opyn::SharedOutputExtractor::getInner ( ) const
inline

◆ getName()

osc::CStringView opyn::SharedOutputExtractor::getName ( ) const
inline

◆ getOutputType()

OutputExtractorDataType opyn::SharedOutputExtractor::getOutputType ( ) const
inline

◆ getOutputValueExtractor()

OutputValueExtractor opyn::SharedOutputExtractor::getOutputValueExtractor ( const OpenSim::Component &  component) const
inline

◆ getValue()

template<typename T >
requires std::constructible_from<T, osc::Variant&&>
T opyn::SharedOutputExtractor::getValue ( const OpenSim::Component &  component,
const StateViewWithMetadata state 
) const
inline

◆ getValues()

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 StateViewWithMetadata&> )
void opyn::SharedOutputExtractor::getValues ( const OpenSim::Component &  component,
const R &  states,
const std::function< void(T)> &  consumer 
) const
inline

◆ operator const OutputExtractor &()

opyn::SharedOutputExtractor::operator const OutputExtractor & ( ) const
inline

◆ 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 StateViewWithMetadata&> )
std::vector< T > opyn::SharedOutputExtractor::slurpValues ( const OpenSim::Component &  component,
const R &  states 
) const
inline

Friends And Related Symbol Documentation

◆ operator==

bool operator== ( const SharedOutputExtractor lhs,
const SharedOutputExtractor rhs 
)
friend

◆ std::hash< SharedOutputExtractor >

friend struct std::hash< SharedOutputExtractor >
friend

◆ to_string

std::string to_string ( const SharedOutputExtractor )
friend

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