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

#include <constant_output_extractor.h>

Inheritance diagram for opyn::ConstantOutputExtractor:
[legend]
Collaboration diagram for opyn::ConstantOutputExtractor:
[legend]

Public Member Functions

 ConstantOutputExtractor (std::string_view name, float value)
 
 ConstantOutputExtractor (std::string_view name, osc::Vector2 value)
 
- 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&&>
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 override
 
osc::CStringView implGetDescription () const override
 
OutputExtractorDataType implGetOutputType () const override
 
OutputValueExtractor implGetOutputValueExtractor (const OpenSim::Component &) const override
 
size_t implGetHash () const override
 
bool implEquals (const OutputExtractor &) const override
 

Friends

bool operator== (const ConstantOutputExtractor &, const ConstantOutputExtractor &)=default
 

Additional Inherited Members

- Protected Member Functions inherited from opyn::OutputExtractor
 OutputExtractor ()=default
 
 OutputExtractor (const OutputExtractor &)=default
 
 OutputExtractor (OutputExtractor &&) noexcept=default
 
OutputExtractoroperator= (const OutputExtractor &)=default
 
OutputExtractoroperator= (OutputExtractor &&) noexcept=default
 

Constructor & Destructor Documentation

◆ ConstantOutputExtractor() [1/2]

opyn::ConstantOutputExtractor::ConstantOutputExtractor ( std::string_view  name,
float  value 
)
inline

◆ ConstantOutputExtractor() [2/2]

opyn::ConstantOutputExtractor::ConstantOutputExtractor ( std::string_view  name,
osc::Vector2  value 
)
inline

Member Function Documentation

◆ implEquals()

bool opyn::ConstantOutputExtractor::implEquals ( const OutputExtractor ) const
overrideprivatevirtual

Implements opyn::OutputExtractor.

◆ implGetDescription()

osc::CStringView opyn::ConstantOutputExtractor::implGetDescription ( ) const
inlineoverrideprivatevirtual

Implements opyn::OutputExtractor.

◆ implGetHash()

size_t opyn::ConstantOutputExtractor::implGetHash ( ) const
overrideprivatevirtual

Implements opyn::OutputExtractor.

◆ implGetName()

osc::CStringView opyn::ConstantOutputExtractor::implGetName ( ) const
inlineoverrideprivatevirtual

Implements opyn::OutputExtractor.

◆ implGetOutputType()

OutputExtractorDataType opyn::ConstantOutputExtractor::implGetOutputType ( ) const
inlineoverrideprivatevirtual

Implements opyn::OutputExtractor.

◆ implGetOutputValueExtractor()

OutputValueExtractor opyn::ConstantOutputExtractor::implGetOutputValueExtractor ( const OpenSim::Component &  ) const
overrideprivatevirtual

Implements opyn::OutputExtractor.

Friends And Related Symbol Documentation

◆ operator==

bool operator== ( const ConstantOutputExtractor ,
const ConstantOutputExtractor  
)
friend

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