opyn::ScalingState Class Reference

#include <scaling_state.h>

Public Member Functions
	ScalingState ()
	ScalingState (const ScalingState &other)
	ScalingState (ScalingState &&tmp) noexcept
	~ScalingState () noexcept=default
ScalingState &	operator= (const ScalingState &other)
ScalingState &	operator= (ScalingState &&tmp) noexcept
const ModelStatePair &	getSourceModel () const
std::shared_ptr< ModelStatePair >	getSourceModelPtr ()
void	loadSourceModelFromOsim (const std::filesystem::path &path)
void	resetSourceModel ()
std::shared_ptr< const ModelWarperV3Document >	getScalingDocumentPtr () const
bool	hasScalingSteps () const
auto	iterateScalingSteps () const
void	addScalingStep (std::unique_ptr< ScalingStep > step)
bool	eraseScalingStep (ScalingStep &step)
bool	eraseScalingStep (const OpenSim::ComponentPath &path)
void	applyScalingObjectPropertyEdit (osc::ObjectPropertyEdit edit)
bool	disableScalingStep (const OpenSim::ComponentPath &path)
std::vector< ScalingDocumentValidationMessage >	getEnabledScalingStepValidationMessages (ScalingCache &scalingCache) const
bool	hasScalingStepValidationIssues (ScalingCache &scalingCache) const
void	resetScalingDocument ()
void	loadScalingDocument (const std::filesystem::path &path)
std::optional< std::filesystem::path >	scalingDocumentFilesystemLocation () const
bool	hasScalingParameterDeclarations () const
ScalingParameters	getEffectiveScalingParameters () const
bool	setScalingParameterOverride (const std::string &scalingParamName, ScalingParameterValue newValue)
std::unique_ptr< BasicModelStatePair >	tryGenerateScaledModel (ScalingCache &scalingCache) const

Constructor & Destructor Documentation

ScalingState() [1/3]

opyn::ScalingState::ScalingState ( )

inlineexplicit

ScalingState() [2/3]

opyn::ScalingState::ScalingState ( const ScalingState &  other )

inline

ScalingState() [3/3]

opyn::ScalingState::ScalingState ( ScalingState &&  tmp )

inlinenoexcept

~ScalingState()

opyn::ScalingState::~ScalingState ( )

defaultnoexcept

Member Function Documentation

addScalingStep()

void opyn::ScalingState::addScalingStep ( std::unique_ptr< ScalingStep >  step )

inline

applyScalingObjectPropertyEdit()

void opyn::ScalingState::applyScalingObjectPropertyEdit ( osc::ObjectPropertyEdit  edit )

inline

disableScalingStep()

bool opyn::ScalingState::disableScalingStep ( const OpenSim::ComponentPath &  path )

inline

eraseScalingStep() [1/2]

bool opyn::ScalingState::eraseScalingStep ( const OpenSim::ComponentPath &  path )

inline

eraseScalingStep() [2/2]

bool opyn::ScalingState::eraseScalingStep ( ScalingStep &  step )

inline

getEffectiveScalingParameters()

ScalingParameters opyn::ScalingState::getEffectiveScalingParameters ( ) const

inline

getEnabledScalingStepValidationMessages()

std::vector< ScalingDocumentValidationMessage > opyn::ScalingState::getEnabledScalingStepValidationMessages ( ScalingCache &  scalingCache ) const

inline

getScalingDocumentPtr()

std::shared_ptr< const ModelWarperV3Document > opyn::ScalingState::getScalingDocumentPtr ( ) const

inline

getSourceModel()

const ModelStatePair & opyn::ScalingState::getSourceModel ( ) const

inline

getSourceModelPtr()

std::shared_ptr< ModelStatePair > opyn::ScalingState::getSourceModelPtr ( )

inline

hasScalingParameterDeclarations()

bool opyn::ScalingState::hasScalingParameterDeclarations ( ) const

inline

hasScalingSteps()

bool opyn::ScalingState::hasScalingSteps ( ) const

inline

hasScalingStepValidationIssues()

bool opyn::ScalingState::hasScalingStepValidationIssues ( ScalingCache &  scalingCache ) const

inline

iterateScalingSteps()

auto opyn::ScalingState::iterateScalingSteps ( ) const

inline

loadScalingDocument()

void opyn::ScalingState::loadScalingDocument ( const std::filesystem::path &  path )

inline

loadSourceModelFromOsim()

void opyn::ScalingState::loadSourceModelFromOsim ( const std::filesystem::path &  path )

inline

operator=() [1/2]

ScalingState & opyn::ScalingState::operator= ( const ScalingState &  other )

inline

operator=() [2/2]

ScalingState & opyn::ScalingState::operator= ( ScalingState &&  tmp )

inlinenoexcept

resetScalingDocument()

void opyn::ScalingState::resetScalingDocument ( )

inline

resetSourceModel()

void opyn::ScalingState::resetSourceModel ( )

inline

scalingDocumentFilesystemLocation()

std::optional< std::filesystem::path > opyn::ScalingState::scalingDocumentFilesystemLocation ( ) const

inline

setScalingParameterOverride()

bool opyn::ScalingState::setScalingParameterOverride ( const std::string &  scalingParamName, ScalingParameterValue  newValue  )

inline

tryGenerateScaledModel()

std::unique_ptr< BasicModelStatePair > opyn::ScalingState::tryGenerateScaledModel ( ScalingCache &  scalingCache ) const

inline

---

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

• /home/adam/Desktop/opensim-creator/third_party/opynsim/libopynsim/solvers/model_warper/scaling_state.h