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

#include <state_view_with_metadata.h>

Public Member Functions

const SimTK::State & getState () const
 
std::optional< float > getAuxiliaryValue (osc::UID id) const
 

Protected Member Functions

 StateViewWithMetadata ()=default
 
 StateViewWithMetadata (const StateViewWithMetadata &)=default
 
 StateViewWithMetadata (StateViewWithMetadata &&) noexcept=default
 
 ~StateViewWithMetadata () noexcept=default
 
StateViewWithMetadataoperator= (const StateViewWithMetadata &)=default
 
StateViewWithMetadataoperator= (StateViewWithMetadata &&) noexcept=default
 

Private Member Functions

virtual const SimTK::State & implGetState () const =0
 
virtual std::optional< float > implGetAuxiliaryValue (osc::UID) const
 

Friends

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

Constructor & Destructor Documentation

◆ StateViewWithMetadata() [1/3]

opyn::StateViewWithMetadata::StateViewWithMetadata ( )
protecteddefault

◆ StateViewWithMetadata() [2/3]

opyn::StateViewWithMetadata::StateViewWithMetadata ( const StateViewWithMetadata )
protecteddefault

◆ StateViewWithMetadata() [3/3]

opyn::StateViewWithMetadata::StateViewWithMetadata ( StateViewWithMetadata &&  )
protecteddefaultnoexcept

◆ ~StateViewWithMetadata()

opyn::StateViewWithMetadata::~StateViewWithMetadata ( )
protecteddefaultnoexcept

Member Function Documentation

◆ getAuxiliaryValue()

std::optional< float > opyn::StateViewWithMetadata::getAuxiliaryValue ( osc::UID  id) const
inline

◆ getState()

const SimTK::State & opyn::StateViewWithMetadata::getState ( ) const
inline

◆ implGetAuxiliaryValue()

virtual std::optional< float > opyn::StateViewWithMetadata::implGetAuxiliaryValue ( osc::UID  ) const
inlineprivatevirtual

◆ implGetState()

virtual const SimTK::State & opyn::StateViewWithMetadata::implGetState ( ) const
privatepure virtual

◆ operator=() [1/2]

StateViewWithMetadata & opyn::StateViewWithMetadata::operator= ( const StateViewWithMetadata )
protecteddefault

◆ operator=() [2/2]

StateViewWithMetadata & opyn::StateViewWithMetadata::operator= ( StateViewWithMetadata &&  )
protecteddefaultnoexcept

Friends And Related Symbol Documentation

◆ operator==

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

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