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

#include <component_output_extractor.h>

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

Public Member Functions

 ComponentOutputExtractor (const OpenSim::AbstractOutput &, ComponentOutputSubfield=ComponentOutputSubfield::None)
 
 ComponentOutputExtractor (const ComponentOutputExtractor &)
 
 ComponentOutputExtractor (ComponentOutputExtractor &&) noexcept
 
ComponentOutputExtractoroperator= (const ComponentOutputExtractor &)
 
ComponentOutputExtractoroperator= (ComponentOutputExtractor &&) noexcept
 
 ~ComponentOutputExtractor () noexcept override
 
const OpenSim::ComponentPath & getComponentAbsPath () 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&&>
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 final
 
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
 
OutputExtractoroperator= (const OutputExtractor &)=default
 
OutputExtractoroperator= (OutputExtractor &&) noexcept=default
 

Constructor & Destructor Documentation

◆ ComponentOutputExtractor() [1/3]

opyn::ComponentOutputExtractor::ComponentOutputExtractor ( const OpenSim::AbstractOutput &  ,
ComponentOutputSubfield  = ComponentOutputSubfield::None 
)

◆ ComponentOutputExtractor() [2/3]

opyn::ComponentOutputExtractor::ComponentOutputExtractor ( const ComponentOutputExtractor )

◆ ComponentOutputExtractor() [3/3]

opyn::ComponentOutputExtractor::ComponentOutputExtractor ( ComponentOutputExtractor &&  )
noexcept

◆ ~ComponentOutputExtractor()

opyn::ComponentOutputExtractor::~ComponentOutputExtractor ( )
overridenoexcept

Member Function Documentation

◆ getComponentAbsPath()

const OpenSim::ComponentPath & opyn::ComponentOutputExtractor::getComponentAbsPath ( ) const

◆ implEquals()

bool opyn::ComponentOutputExtractor::implEquals ( const OutputExtractor ) const
finalprivatevirtual

Implements opyn::OutputExtractor.

◆ implGetDescription()

osc::CStringView opyn::ComponentOutputExtractor::implGetDescription ( ) const
finalprivatevirtual

Implements opyn::OutputExtractor.

◆ implGetHash()

size_t opyn::ComponentOutputExtractor::implGetHash ( ) const
finalprivatevirtual

Implements opyn::OutputExtractor.

◆ implGetName()

osc::CStringView opyn::ComponentOutputExtractor::implGetName ( ) const
finalprivatevirtual

Implements opyn::OutputExtractor.

◆ implGetOutputType()

OutputExtractorDataType opyn::ComponentOutputExtractor::implGetOutputType ( ) const
finalprivatevirtual

Implements opyn::OutputExtractor.

◆ implGetOutputValueExtractor()

OutputValueExtractor opyn::ComponentOutputExtractor::implGetOutputValueExtractor ( const OpenSim::Component &  ) const
finalprivatevirtual

Implements opyn::OutputExtractor.

◆ operator=() [1/2]

ComponentOutputExtractor & opyn::ComponentOutputExtractor::operator= ( ComponentOutputExtractor &&  )
noexcept

◆ operator=() [2/2]

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

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