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

#include <model_state_pair.h>

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

Public Member Functions

virtual ~ModelStatePair () noexcept=default
 
const OpenSim::Model & getModel () const
 
 operator const OpenSim::Model & () const
 
const OpenSim::Model * operator-> () const
 
const SimTK::State & getState () const
 
bool isReadonly () const
 
bool canUpdModel () const
 
OpenSim::Model & updModel ()
 
void commit (std::string_view commitMessage)
 
osc::UID getModelVersion () const
 
void setModelVersion (osc::UID id)
 
osc::UID getStateVersion () const
 
const OpenSim::Component * getSelected () const
 
template<typename T >
const T * getSelectedAs () const
 
void setSelected (const OpenSim::Component *newSelection)
 
void clearSelected ()
 
const OpenSim::Component * getHovered () const
 
void setHovered (const OpenSim::Component *newHover)
 
float getFixupScaleFactor () const
 
void setFixupScaleFactor (float newScaleFactor)
 
void setUpToDateWithFilesystem (std::filesystem::file_time_type t)
 
- Public Member Functions inherited from opyn::VersionedComponentAccessor
osc::UID getComponentVersion () const
 
void setComponentVersion (osc::UID id)
 
- Public Member Functions inherited from opyn::ComponentAccessor
virtual ~ComponentAccessor () noexcept=default
 
const OpenSim::Component & getComponent () const
 
 operator const OpenSim::Component & () const
 
bool isReadonly () const
 
bool canUpdComponent () const
 
OpenSim::Component & updComponent ()
 

Protected Member Functions

 ModelStatePair ()=default
 
 ModelStatePair (const ModelStatePair &)=default
 
 ModelStatePair (ModelStatePair &&) noexcept=default
 
ModelStatePair & operator= (const ModelStatePair &)=default
 
ModelStatePair & operator= (ModelStatePair &&) noexcept=default
 
- Protected Member Functions inherited from opyn::ComponentAccessor
 ComponentAccessor ()=default
 
 ComponentAccessor (const ComponentAccessor &)=default
 
 ComponentAccessor (ComponentAccessor &&) noexcept=default
 
ComponentAccessor & operator= (const ComponentAccessor &)=default
 
ComponentAccessor & operator= (ComponentAccessor &&) noexcept=default
 

Private Member Functions

const OpenSim::Component & implGetComponent () const final
 
OpenSim::Component & implUpdComponent () final
 
osc::UID implGetComponentVersion () const final
 
void implSetComponentVersion (osc::UID newVersion) final
 
virtual const OpenSim::Model & implGetModel () const =0
 
virtual const SimTK::State & implGetState () const =0
 
virtual bool implCanUpdModel () const
 
virtual OpenSim::Model & implUpdModel ()
 
virtual void implCommit (std::string_view)
 
virtual osc::UID implGetModelVersion () const
 
virtual void implSetModelVersion (osc::UID)
 
virtual osc::UID implGetStateVersion () const
 
virtual const OpenSim::Component * implGetSelected () const
 
virtual const OpenSim::Component * implGetHovered () const
 
virtual float implGetFixupScaleFactor () const
 
virtual void implSetFixupScaleFactor (float)
 
virtual void implSetSelected (const OpenSim::Component *)
 
virtual void implSetHovered (const OpenSim::Component *)
 
virtual void implSetUpToDateWithFilesystem (std::filesystem::file_time_type)
 

Friends

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

Constructor & Destructor Documentation

◆ ModelStatePair() [1/3]

opyn::ModelStatePair::ModelStatePair ( )
protecteddefault

◆ ModelStatePair() [2/3]

opyn::ModelStatePair::ModelStatePair ( const ModelStatePair &  )
protecteddefault

◆ ModelStatePair() [3/3]

opyn::ModelStatePair::ModelStatePair ( ModelStatePair &&  )
protecteddefaultnoexcept

◆ ~ModelStatePair()

virtual opyn::ModelStatePair::~ModelStatePair ( )
virtualdefaultnoexcept

Member Function Documentation

◆ canUpdModel()

bool opyn::ModelStatePair::canUpdModel ( ) const
inline

◆ clearSelected()

void opyn::ModelStatePair::clearSelected ( )
inline

◆ commit()

void opyn::ModelStatePair::commit ( std::string_view  commitMessage)
inline

◆ getFixupScaleFactor()

float opyn::ModelStatePair::getFixupScaleFactor ( ) const
inline

◆ getHovered()

const OpenSim::Component * opyn::ModelStatePair::getHovered ( ) const
inline

◆ getModel()

const OpenSim::Model & opyn::ModelStatePair::getModel ( ) const
inline

◆ getModelVersion()

osc::UID opyn::ModelStatePair::getModelVersion ( ) const
inline

◆ getSelected()

const OpenSim::Component * opyn::ModelStatePair::getSelected ( ) const
inline

◆ getSelectedAs()

template<typename T >
const T * opyn::ModelStatePair::getSelectedAs ( ) const
inline

◆ getState()

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

◆ getStateVersion()

osc::UID opyn::ModelStatePair::getStateVersion ( ) const
inline

◆ implCanUpdModel()

virtual bool opyn::ModelStatePair::implCanUpdModel ( ) const
inlineprivatevirtual

◆ implCommit()

virtual void opyn::ModelStatePair::implCommit ( std::string_view  )
inlineprivatevirtual

◆ implGetComponent()

const OpenSim::Component & opyn::ModelStatePair::implGetComponent ( ) const
finalprivatevirtual

Implements opyn::ComponentAccessor.

◆ implGetComponentVersion()

osc::UID opyn::ModelStatePair::implGetComponentVersion ( ) const
inlinefinalprivatevirtual

Reimplemented from opyn::VersionedComponentAccessor.

◆ implGetFixupScaleFactor()

virtual float opyn::ModelStatePair::implGetFixupScaleFactor ( ) const
inlineprivatevirtual

Reimplemented in opyn::BasicModelStatePair.

◆ implGetHovered()

virtual const OpenSim::Component * opyn::ModelStatePair::implGetHovered ( ) const
inlineprivatevirtual

◆ implGetModel()

virtual const OpenSim::Model & opyn::ModelStatePair::implGetModel ( ) const
privatepure virtual

Implemented in opyn::BasicModelStatePair.

◆ implGetModelVersion()

virtual osc::UID opyn::ModelStatePair::implGetModelVersion ( ) const
inlineprivatevirtual

◆ implGetSelected()

virtual const OpenSim::Component * opyn::ModelStatePair::implGetSelected ( ) const
inlineprivatevirtual

◆ implGetState()

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

Implemented in opyn::BasicModelStatePair.

◆ implGetStateVersion()

virtual osc::UID opyn::ModelStatePair::implGetStateVersion ( ) const
inlineprivatevirtual

◆ implSetComponentVersion()

void opyn::ModelStatePair::implSetComponentVersion ( osc::UID  newVersion)
inlinefinalprivatevirtual

Reimplemented from opyn::VersionedComponentAccessor.

◆ implSetFixupScaleFactor()

virtual void opyn::ModelStatePair::implSetFixupScaleFactor ( float  )
inlineprivatevirtual

Reimplemented in opyn::BasicModelStatePair.

◆ implSetHovered()

virtual void opyn::ModelStatePair::implSetHovered ( const OpenSim::Component *  )
inlineprivatevirtual

◆ implSetModelVersion()

virtual void opyn::ModelStatePair::implSetModelVersion ( osc::UID  )
inlineprivatevirtual

◆ implSetSelected()

virtual void opyn::ModelStatePair::implSetSelected ( const OpenSim::Component *  )
inlineprivatevirtual

◆ implSetUpToDateWithFilesystem()

virtual void opyn::ModelStatePair::implSetUpToDateWithFilesystem ( std::filesystem::file_time_type  )
inlineprivatevirtual

◆ implUpdComponent()

OpenSim::Component & opyn::ModelStatePair::implUpdComponent ( )
finalprivatevirtual

Reimplemented from opyn::ComponentAccessor.

◆ implUpdModel()

virtual OpenSim::Model & opyn::ModelStatePair::implUpdModel ( )
inlineprivatevirtual

◆ isReadonly()

bool opyn::ModelStatePair::isReadonly ( ) const
inline

◆ operator const OpenSim::Model &()

opyn::ModelStatePair::operator const OpenSim::Model & ( ) const
inline

◆ operator->()

const OpenSim::Model * opyn::ModelStatePair::operator-> ( ) const
inline

◆ operator=() [1/2]

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

◆ operator=() [2/2]

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

◆ setFixupScaleFactor()

void opyn::ModelStatePair::setFixupScaleFactor ( float  newScaleFactor)
inline

◆ setHovered()

void opyn::ModelStatePair::setHovered ( const OpenSim::Component *  newHover)
inline

◆ setModelVersion()

void opyn::ModelStatePair::setModelVersion ( osc::UID  id)
inline

◆ setSelected()

void opyn::ModelStatePair::setSelected ( const OpenSim::Component *  newSelection)
inline

◆ setUpToDateWithFilesystem()

void opyn::ModelStatePair::setUpToDateWithFilesystem ( std::filesystem::file_time_type  t)
inline

◆ updModel()

OpenSim::Model & opyn::ModelStatePair::updModel ( )
inline

Friends And Related Symbol Documentation

◆ operator==

bool operator== ( const ModelStatePair &  ,
const ModelStatePair &   
)
friend
The documentation for this class was generated from the following file:
Generated by doxygen 1.9.8