This defines the abstract ModelComponent class, which is used to specify components of a musculoskeletal model and the elements they add to the underlying computational SimTK::System (MultibodySystem). More...

Inheritance diagram for OpenSim::ModelComponent:

Public Member Functions
	ModelComponent ()
	Default constructor. More...

	ModelComponent (const std::string &aFileName, bool aUpdateFromXMLNode=true)
	Construct ModelComponent from an XML file. More...

	ModelComponent (SimTK::Xml::Element &aNode)
	Construct ModelComponent from a specific node in an XML document. More...

virtual	~ModelComponent ()
	Destructor is virtual to allow concrete model component cleanup. More...

void	connectToModel (Model &model)
	Connect this ModelComponent to its aggregate- a Model. More...

const Model &	getModel () const
	Get a const reference to the Model this component is part of. More...

Model &	updModel ()
	Get a modifiable reference to the Model this component is part of. More...

bool	hasModel () const
	Does this ModelComponent have a Model associated with it? More...

void	preScale (const SimTK::State &s, const ScaleSet &scaleSet)
	Perform any computations that must occur before ModelComponent::scale() is invoked on all ModelComponents in the Model. More...

void	scale (const SimTK::State &s, const ScaleSet &scaleSet)
	Scale the ModelComponent. More...

void	postScale (const SimTK::State &s, const ScaleSet &scaleSet)
	Perform any computations that must occur after ModelComponent::scale() has been invoked on all ModelComponents in the Model. More...

Public Member Functions inherited from OpenSim::Component
Public Member Functions inherited from OpenSim::Object
virtual	~Object ()
	Virtual destructor for cleanup. More...

bool	isEqualTo (const Object &aObject) const
	Equality operator wrapper for use from languages not supporting operator overloading. More...

Object &	operator= (const Object &aObject)
	Copy assignment copies he base class fields, including the properties. More...

virtual bool	operator== (const Object &aObject) const
	Determine if two objects are equal. More...

virtual bool	operator< (const Object &aObject) const
	Provide an ordering for objects so they can be put in sorted containers. More...

void	setName (const std::string &name)
	Set the name of the Object. More...

const std::string &	getName () const
	Get the name of this Object. More...

void	setDescription (const std::string &description)
	Set description, a one-liner summary. More...

const std::string &	getDescription () const
	Get description, a one-liner summary. More...

const std::string &	getAuthors () const
	Get Authors of this Object. More...

void	setAuthors (const std::string &authors)
	Set Authors of this object. More...

const std::string &	getReferences () const
	Get references or publications to cite if using this object. More...

void	setReferences (const std::string &references)
	Set references or publications to cite if using this object. More...

int	getNumProperties () const
	Determine how many properties are stored with this Object. More...

const AbstractProperty &	getPropertyByIndex (int propertyIndex) const
	Get a const reference to a property by its index number, returned as an AbstractProperty. More...

AbstractProperty &	updPropertyByIndex (int propertyIndex)
	Get a writable reference to a property by its index number, returned as an AbstractProperty. More...

bool	hasProperty (const std::string &name) const
	Return true if this Object has a property of any type with the given name, which must not be empty. More...

const AbstractProperty &	getPropertyByName (const std::string &name) const
	Get a const reference to a property by its name, returned as an AbstractProperty. More...

AbstractProperty &	updPropertyByName (const std::string &name)
	Get a writable reference to a property by its name, returned as an AbstractProperty. More...

template<class T >
bool	hasProperty () const
	Return true if this Object contains an unnamed, one-object property that contains objects of the given template type T. More...

template<class T >
const Property< T > &	getProperty (const PropertyIndex &index) const
	Get property of known type Property<T> as a const reference; the property must be present and have the right type. More...

template<class T >
Property< T > &	updProperty (const PropertyIndex &index)
	Get property of known type Property<T> as a writable reference; the property must be present and have the right type. More...

bool	isObjectUpToDateWithProperties () const
	Returns `true` if no property's value has changed since the last time setObjectIsUpToDateWithProperties() was called. More...

void	readObjectFromXMLNodeOrFile (SimTK::Xml::Element &objectElement, int versionNumber)
	We're given an XML element from which we are to populate this Object. More...

void	updateXMLNode (SimTK::Xml::Element &parent, const AbstractProperty *prop=nullptr) const
	Serialize this object into the XML node that represents it. More...

bool	getInlined () const
	Inlined means an in-memory Object that is not associated with an XMLDocument. More...

void	setInlined (bool aInlined, const std::string &aFileName="")
	Mark this as inlined or not and optionally provide a file name to associate with the new XMLDocument for the non-inline case. More...

std::string	getDocumentFileName () const
	If there is a document associated with this object then return the file name maintained by the document. More...

int	getDocumentFileVersion () const
	If there is a document associated with this object then return its version number. More...

void	setAllPropertiesUseDefault (bool aUseDefault)

bool	print (const std::string &fileName) const
	Write this Object into an XML file of the given name; conventionally the suffix to use is ".osim". More...

std::string	dump () const
	dump the XML representation of this Object into an std::string and return it. More...

virtual bool	isA (const char *type) const
	The default implementation returns true only if the supplied string is "Object"; each Object-derived class overrides this to match its own class name. More...

const std::string &	toString () const
	Wrapper to be used on Java side to display objects in tree; this returns just the object's name. More...

PropertySet &	getPropertySet ()
	OBSOLETE: Get a reference to the PropertySet maintained by the Object. More...

const PropertySet &	getPropertySet () const

Static Public Member Functions
Auto-generated functions
static ModelComponent *	safeDownCast (OpenSim::Object *obj)
	For use in MATLAB and Python to access the concrete class. More...

Static Public Member Functions inherited from OpenSim::Component
static Component *	safeDownCast (OpenSim::Object *obj)
	For use in MATLAB and Python to access the concrete class. More...

static const std::string &	getClassName ()
	This returns "Component" More...

Static Public Member Functions inherited from OpenSim::Object
static void	registerType (const Object &defaultObject)
	Register an instance of a class; if the class is already registered it will be replaced. More...

static void	renameType (const std::string &oldTypeName, const std::string &newTypeName)
	Support versioning by associating the current Object type with an old name. More...

static const Object *	getDefaultInstanceOfType (const std::string &concreteClassName)
	Return a pointer to the default instance of the registered (concrete) Object whose class name is given, or NULL if the type is not registered. More...

template<class T >
static bool	isObjectTypeDerivedFrom (const std::string &concreteClassName)
	Return true if the given concrete object type represents a subclass of the template object type T, and thus could be referenced with a T*. More...

static Object *	newInstanceOfType (const std::string &concreteClassName)
	Create a new instance of the concrete Object type whose class name is given as concreteClassName. More...

static void	getRegisteredTypenames (Array< std::string > &typeNames)
	Retrieve all the typenames registered so far. More...

template<class T >
static void	getRegisteredObjectsOfGivenType (ArrayPtrs< T > &rArray)
	Return an array of pointers to the default instances of all registered (concrete) Object types that derive from a given Object-derived type that does not have to be concrete. More...

static bool	PrintPropertyInfo (std::ostream &os, const std::string &classNameDotPropertyName, bool printFlagInfo=true)
	Dump formatted property information to a given output stream, useful for creating a "help" facility for registered objects. More...

static bool	PrintPropertyInfo (std::ostream &os, const std::string &className, const std::string &propertyName, bool printFlagInfo=true)
	Same as the other signature but the class name and property name are provided as two separate strings. More...

static Object *	makeObjectFromFile (const std::string &fileName)
	Create an OpenSim object whose type is based on the tag at the root node of the XML file passed in. More...

static const std::string &	getClassName ()
	Return the name of this class as a string; i.e., "Object". More...

static void	setSerializeAllDefaults (bool shouldSerializeDefaults)
	Static function to control whether all registered objects and their properties are written to the defaults section of output files rather than only those values for which the default was explicitly overwritten when read in from an input file or set programmatically. More...

static bool	getSerializeAllDefaults ()
	Report the value of the "serialize all defaults" flag. More...

static bool	isKindOf (const char *type)
	Returns true if the passed-in string is "Object"; each Object-derived class defines a method of this name for its own class name. More...

static void	setDebugLevel (int newLevel)
	Set the amount of logging output. More...

static int	getDebugLevel ()
	Get the current setting of debug level. More...

static Object *	SafeCopy (const Object *aObject)
	Use the clone() method to duplicate the given object unless the pointer is null in which case null is returned. More...

static void	RegisterType (const Object &defaultObject)
	OBSOLETE alternate name for registerType(). More...

static void	RenameType (const std::string &oldName, const std::string &newName)
	OBSOLETE alternate name for renameType(). More...

ModelComponent System Creation and Access Methods
These methods support implementing concrete ModelComponents. Add methods can only be called inside of extendAddToSystem() and are useful for creating the underlying SimTK::System level variables that are used for computing values of interest. Warning Accessors for System indices are intended for component internal use only.
SimTK::ReferencePtr< Model >	_model
	The model this component belongs to. More...

void	updateFromXMLNode (SimTK::Xml::Element &aNode, int versionNumber) override
	Use this method to deserialize an object from a SimTK::Xml::Element. More...

Auto-generated functions <br>
static const std::string &	getClassName ()
	This returns "ModelComponent" More...

ModelComponent *	clone () const override=0
	Create a new heap-allocated copy of the concrete object to which this Object refers. More...

const std::string &	getConcreteClassName () const override=0
	Returns the class name of the concrete Object-derived class of the actual object referenced by this Object, as a string. More...

Detailed Description

This defines the abstract ModelComponent class, which is used to specify components of a musculoskeletal model and the elements they add to the underlying computational SimTK::System (MultibodySystem).

A ModelComponent is an OpenSim::Component and therefore has the capabilities to add necessary system resources to the System and to manage access to those resources (

See also: Component)

Bodies, Joints, Coordinates, Constraints, Forces, Actuators, Controllers, and even Model itself, are ModelComponents. Each component is "connected" to a model and an underlying SimTK::Subsystem, which by default is the System's DefaultSubsystem.

The primary responsibility of a ModelComponent is to add its computational representation(s) of physical musculoskeletal structures to the underlying SimTK::System by implementing extendAddToSystem().

Additional methods provide support for adding modeling options, state and cache variables (

See also: Component).

Public methods enable access to component variables via their names.

Author: Ajay Seth, Michael Sherman

Constructor & Destructor Documentation

◆ ModelComponent() [1/3]

OpenSim::ModelComponent::ModelComponent ( )

Default constructor.

◆ ModelComponent() [2/3]

OpenSim::ModelComponent::ModelComponent	(	const std::string &	aFileName,
		bool	aUpdateFromXMLNode = `true`
	)

Construct ModelComponent from an XML file.

◆ ModelComponent() [3/3]

OpenSim::ModelComponent::ModelComponent ( SimTK::Xml::Element & aNode )

explicit

Construct ModelComponent from a specific node in an XML document.

◆ ~ModelComponent()

virtual OpenSim::ModelComponent::~ModelComponent ( )

inlinevirtual

Destructor is virtual to allow concrete model component cleanup.

Member Function Documentation

◆ clone()

ModelComponent * OpenSim::ModelComponent::clone ( ) const

overridepure virtual

Create a new heap-allocated copy of the concrete object to which this Object refers.

It is up to the caller to delete the returned object when no longer needed. Every concrete object deriving from Object implements this pure virtual method automatically, via the declaration macro it invokes (e.g., OpenSim_DECLARE_CONCRETE_OBJECT()). Note that the concrete class overrides modify the return type to be a pointer to the concrete object; that still overrides the base class method because the return type is covariant with (that is, derives from) Object.

Implements OpenSim::Component.

Implemented in OpenSim::ActivationCoordinateActuator, OpenSim::BodyActuator, OpenSim::ClutchedPathSpring, OpenSim::ConstantMuscleActivation, OpenSim::CoordinateActuator, OpenSim::DeGrooteFregly2016Muscle, OpenSim::Delp1990Muscle_Deprecated, OpenSim::FirstOrderMuscleActivationDynamics, OpenSim::McKibbenActuator, OpenSim::Millard2012AccelerationMuscle, OpenSim::Millard2012EquilibriumMuscle, OpenSim::MuscleFirstOrderActivationDynamicModel, OpenSim::MuscleFixedWidthPennationModel, OpenSim::PointActuator, OpenSim::PointToPointActuator, OpenSim::RigidTendonMuscle, OpenSim::Schutte1993Muscle_Deprecated, OpenSim::SpringGeneralizedForce, OpenSim::Thelen2003Muscle, OpenSim::Thelen2003Muscle_Deprecated, OpenSim::TorqueActuator, OpenSim::ZerothOrderMuscleActivationDynamics, OpenSim::Set< ModelComponent, ModelComponent >, OpenSim::AccelerationMotion, OpenSim::DiscreteController, OpenSim::DiscreteForces, OpenSim::AckermannVanDenBogert2010Force, OpenSim::MeyerFregly2016Force, OpenSim::EspositoMiller2018Force, OpenSim::ControlSetController, OpenSim::PrescribedController, OpenSim::ActuatorForceProbe, OpenSim::ActuatorPowerProbe, OpenSim::Bhargava2004MuscleMetabolicsProbe, OpenSim::Bhargava2004SmoothedMuscleMetabolics, OpenSim::Blankevoort1991Ligament, OpenSim::BushingForce, OpenSim::ComponentSet, OpenSim::ConditionalPathPoint, OpenSim::ContactHalfSpace, OpenSim::ContactMesh, OpenSim::ContactSphere, OpenSim::CoordinateLimitForce, OpenSim::ElasticFoundationForce, OpenSim::ElasticFoundationForce, OpenSim::ElasticFoundationForce, OpenSim::ExpressionBasedBushingForce, OpenSim::ExpressionBasedCoordinateForce, OpenSim::ExpressionBasedPointToPointForce, OpenSim::ExternalForce, OpenSim::FunctionBasedBushingForce, OpenSim::GeometryPath, OpenSim::Ground, OpenSim::HuntCrossleyForce, OpenSim::HuntCrossleyForce, OpenSim::HuntCrossleyForce, OpenSim::JointInternalPowerProbe, OpenSim::Ligament, OpenSim::Marker, OpenSim::ModelComponentSet< T >, OpenSim::ModelComponentSet< ModelComponent >, OpenSim::MovingPathPoint, OpenSim::MuscleActiveFiberPowerProbe, OpenSim::PathActuator, OpenSim::PathPoint, OpenSim::PathSpring, OpenSim::PhysicalOffsetFrame, OpenSim::PointToPointSpring, OpenSim::PrescribedForce, OpenSim::SmoothSphereHalfSpaceForce, OpenSim::Station, OpenSim::SystemEnergyProbe, OpenSim::Umberger2010MuscleMetabolicsProbe, OpenSim::ExperimentalFrame, OpenSim::ExperimentalMarker, OpenSim::IMU, OpenSim::PositionMotion, OpenSim::BallJoint, OpenSim::Body, OpenSim::ConstantDistanceConstraint, OpenSim::Coordinate, OpenSim::CoordinateCouplerConstraint, OpenSim::CustomJoint, OpenSim::EllipsoidJoint, OpenSim::FreeJoint, OpenSim::GimbalJoint, OpenSim::PinJoint, OpenSim::PlanarJoint, OpenSim::PointConstraint, OpenSim::PointOnLineConstraint, OpenSim::RollingOnSurfaceConstraint, OpenSim::ScapulothoracicJoint, OpenSim::SliderJoint, OpenSim::UniversalJoint, OpenSim::WeldConstraint, OpenSim::WeldJoint, OpenSim::PathWrapPoint, OpenSim::WrapCylinder, OpenSim::WrapEllipsoid, OpenSim::WrapSphere, OpenSim::WrapTorus, OpenSim::CMC, OpenSim::CorrectionController, OpenSim::MuscleActivationDynamics, OpenSim::StationPlaneContactForce, OpenSim::Controller, OpenSim::AbstractPathPoint, OpenSim::ActivationFiberLengthMuscle, OpenSim::ActivationFiberLengthMuscle_Deprecated, OpenSim::Actuator, OpenSim::ScalarActuator, OpenSim::ContactGeometry, OpenSim::Force, OpenSim::Frame, OpenSim::Muscle, OpenSim::OffsetFrame< C >, OpenSim::OffsetFrame< PhysicalFrame >, OpenSim::PhysicalFrame, OpenSim::Point, OpenSim::Probe, OpenSim::TwoFrameLinker< Force, PhysicalFrame >, OpenSim::TwoFrameLinker< Constraint, PhysicalFrame >, OpenSim::Constraint, OpenSim::Joint, OpenSim::UnilateralConstraint, and OpenSim::WrapObject.

◆ connectToModel()

void OpenSim::ModelComponent::connectToModel ( Model & model )

Connect this ModelComponent to its aggregate- a Model.

◆ extendConnectToModel()

virtual void OpenSim::ModelComponent::extendConnectToModel ( Model & model )

inlineprotectedvirtual

Perform any necessary initializations required to connect the component into the Model, and check for error conditions.

extendConnectToModel() is invoked on all components to complete construction of a Model, prior to creating a Simbody System to represent it computationally. It may also be invoked at times just for its error-checking side effects.

If you override this method, be sure to invoke the base class method first, using code like this:

void MyComponent::extendConnectToModel(Model& model) {
    Super::extendConnectToModel(model); // invoke parent class method
    // ... your code goes here
}

Note that this method is expected to check for modeling errors and should throw an OpenSim::Exception if there is something wrong. For example, if your model component references another object by name, you should verify that it exists in the supplied Model, which is not guaranteed since components may be independently instantiated or constructed from XML files.

Parameters

[in,out] model The Model currently being constructed to which this ModelComponent should be connected.

Reimplemented in OpenSim::Delp1990Muscle_Deprecated, OpenSim::UnilateralConstraint, OpenSim::CMC, and OpenSim::CorrectionController.

◆ extendFinalizeFromProperties()

void OpenSim::ModelComponent::extendFinalizeFromProperties ( )

overrideprotected

◆ extendPostScale()

virtual void OpenSim::ModelComponent::extendPostScale	(	const SimTK::State &	s,
		const ScaleSet &	scaleSet
	)

inlineprotectedvirtual

Perform any computations that must occur after ModelComponent::scale() has been invoked on all ModelComponents in the Model.

This method is virtual and may be implemented by any subclass of ModelComponent, but all implementations must begin with a call to Super::extendPostScale() to execute the parent class methods before the child class method. The base class implementation in ModelComponent does nothing.

See also: postScale()

Reimplemented in OpenSim::ActivationFiberLengthMuscle_Deprecated.

◆ extendPreScale()

virtual void OpenSim::ModelComponent::extendPreScale	(	const SimTK::State &	s,
		const ScaleSet &	scaleSet
	)

inlineprotectedvirtual

Perform any computations that must occur before ModelComponent::scale() is invoked on all ModelComponents in the Model.

For example, a GeometryPath must calculate and store its path length in the original model before scaling so that an owning Muscle can use this information to update the properties of the muscle after scaling. This method is virtual and may be implemented by any subclass of ModelComponent, but all implementations must begin with a call to Super::extendPreScale() to execute the parent class methods before the child class method. The base class implementation in ModelComponent does nothing.

See also: preScale()

◆ extendScale()

virtual void OpenSim::ModelComponent::extendScale	(	const SimTK::State &	s,
		const ScaleSet &	scaleSet
	)

inlineprotectedvirtual

Scale the ModelComponent.

This method is virtual and may be implemented by any subclass of ModelComponent, but all implementations must begin with a call to Super::extendScale() to execute the parent class methods before the child class method. The base class implementation in ModelComponent does nothing.

See also: scale()

◆ getClassName()

static const std::string & OpenSim::ModelComponent::getClassName ( )

inlinestatic

This returns "ModelComponent"

See getConcreteClassName() if you want the class name of the underlying concrete object instead.

◆ getConcreteClassName()

const std::string & OpenSim::ModelComponent::getConcreteClassName ( ) const

overridepure virtual

Returns the class name of the concrete Object-derived class of the actual object referenced by this Object, as a string.

This is the string that is used as the tag for this concrete object in an XML file. Every concrete class derived from Object automatically overrides this method via the declaration macro it uses. See getClassName() to get the class name of the referencing (possibly abstract) class rather than the concrete object.

See also: getClassName()

Implements OpenSim::Component.

Implemented in OpenSim::ActivationCoordinateActuator, OpenSim::BodyActuator, OpenSim::ClutchedPathSpring, OpenSim::ConstantMuscleActivation, OpenSim::CoordinateActuator, OpenSim::DeGrooteFregly2016Muscle, OpenSim::Delp1990Muscle_Deprecated, OpenSim::FirstOrderMuscleActivationDynamics, OpenSim::McKibbenActuator, OpenSim::Millard2012AccelerationMuscle, OpenSim::Millard2012EquilibriumMuscle, OpenSim::MuscleFirstOrderActivationDynamicModel, OpenSim::MuscleFixedWidthPennationModel, OpenSim::PointActuator, OpenSim::PointToPointActuator, OpenSim::RigidTendonMuscle, OpenSim::Schutte1993Muscle_Deprecated, OpenSim::SpringGeneralizedForce, OpenSim::Thelen2003Muscle, OpenSim::Thelen2003Muscle_Deprecated, OpenSim::TorqueActuator, OpenSim::ZerothOrderMuscleActivationDynamics, OpenSim::Set< ModelComponent, ModelComponent >, OpenSim::AccelerationMotion, OpenSim::DiscreteController, OpenSim::DiscreteForces, OpenSim::AckermannVanDenBogert2010Force, OpenSim::MeyerFregly2016Force, OpenSim::EspositoMiller2018Force, OpenSim::ControlSetController, OpenSim::PrescribedController, OpenSim::ActuatorForceProbe, OpenSim::ActuatorPowerProbe, OpenSim::Bhargava2004MuscleMetabolicsProbe, OpenSim::Bhargava2004SmoothedMuscleMetabolics, OpenSim::Blankevoort1991Ligament, OpenSim::BushingForce, OpenSim::ComponentSet, OpenSim::ConditionalPathPoint, OpenSim::ContactHalfSpace, OpenSim::ContactMesh, OpenSim::ContactSphere, OpenSim::CoordinateLimitForce, OpenSim::ElasticFoundationForce, OpenSim::ElasticFoundationForce, OpenSim::ElasticFoundationForce, OpenSim::ExpressionBasedBushingForce, OpenSim::ExpressionBasedCoordinateForce, OpenSim::ExpressionBasedPointToPointForce, OpenSim::ExternalForce, OpenSim::FunctionBasedBushingForce, OpenSim::GeometryPath, OpenSim::Ground, OpenSim::HuntCrossleyForce, OpenSim::HuntCrossleyForce, OpenSim::HuntCrossleyForce, OpenSim::JointInternalPowerProbe, OpenSim::Ligament, OpenSim::Marker, OpenSim::ModelComponentSet< T >, OpenSim::ModelComponentSet< ModelComponent >, OpenSim::MovingPathPoint, OpenSim::MuscleActiveFiberPowerProbe, OpenSim::PathActuator, OpenSim::PathPoint, OpenSim::PathSpring, OpenSim::PhysicalOffsetFrame, OpenSim::PointToPointSpring, OpenSim::PrescribedForce, OpenSim::SmoothSphereHalfSpaceForce, OpenSim::Station, OpenSim::SystemEnergyProbe, OpenSim::Umberger2010MuscleMetabolicsProbe, OpenSim::ExperimentalFrame, OpenSim::ExperimentalMarker, OpenSim::IMU, OpenSim::PositionMotion, OpenSim::BallJoint, OpenSim::Body, OpenSim::ConstantDistanceConstraint, OpenSim::Coordinate, OpenSim::CoordinateCouplerConstraint, OpenSim::CustomJoint, OpenSim::EllipsoidJoint, OpenSim::FreeJoint, OpenSim::GimbalJoint, OpenSim::PinJoint, OpenSim::PlanarJoint, OpenSim::PointConstraint, OpenSim::PointOnLineConstraint, OpenSim::RollingOnSurfaceConstraint, OpenSim::ScapulothoracicJoint, OpenSim::SliderJoint, OpenSim::UniversalJoint, OpenSim::WeldConstraint, OpenSim::WeldJoint, OpenSim::PathWrapPoint, OpenSim::WrapCylinder, OpenSim::WrapEllipsoid, OpenSim::WrapSphere, OpenSim::WrapTorus, OpenSim::CMC, OpenSim::CorrectionController, OpenSim::MuscleActivationDynamics, OpenSim::StationPlaneContactForce, OpenSim::Controller, OpenSim::AbstractPathPoint, OpenSim::ActivationFiberLengthMuscle, OpenSim::ActivationFiberLengthMuscle_Deprecated, OpenSim::Actuator, OpenSim::ScalarActuator, OpenSim::ContactGeometry, OpenSim::Force, OpenSim::Frame, OpenSim::Muscle, OpenSim::OffsetFrame< C >, OpenSim::OffsetFrame< PhysicalFrame >, OpenSim::PhysicalFrame, OpenSim::Point, OpenSim::Probe, OpenSim::TwoFrameLinker< Force, PhysicalFrame >, OpenSim::TwoFrameLinker< Constraint, PhysicalFrame >, OpenSim::Constraint, OpenSim::Joint, OpenSim::UnilateralConstraint, and OpenSim::WrapObject.

◆ getModel()

const Model & OpenSim::ModelComponent::getModel ( ) const

Get a const reference to the Model this component is part of.

Referenced by OpenSim::MocoPhase::getModel().

◆ getScaleFactors()

const SimTK::Vec3 & OpenSim::ModelComponent::getScaleFactors	(	const ScaleSet &	scaleSet,
		const Frame &	frame
	)		const

protected

Get the scale factors corresponding to the base OpenSim::Body of the specified Frame.

Returns ModelComponent::InvalidScaleFactors if the ScaleSet does not contain scale factors for the base Body.

◆ hasModel()

bool OpenSim::ModelComponent::hasModel ( ) const

inline

Does this ModelComponent have a Model associated with it?

◆ postScale()

void OpenSim::ModelComponent::postScale	(	const SimTK::State &	s,
		const ScaleSet &	scaleSet
	)

Perform any computations that must occur after ModelComponent::scale() has been invoked on all ModelComponents in the Model.

This method calls the virtual extendPostScale() method, which may be implemented by any subclass of ModelComponent.

See also: preScale(); scale(); extendPostScale()

◆ preScale()

void OpenSim::ModelComponent::preScale	(	const SimTK::State &	s,
		const ScaleSet &	scaleSet
	)

Perform any computations that must occur before ModelComponent::scale() is invoked on all ModelComponents in the Model.

For example, a GeometryPath must calculate and store its path length in the original model before scaling so that an owning Muscle can use this information to update the properties of the muscle after scaling. This method calls the virtual extendPreScale() method, which may be implemented by any subclass of ModelComponent.

See also: extendPreScale(); scale(); postScale()

◆ safeDownCast()

static ModelComponent * OpenSim::ModelComponent::safeDownCast ( OpenSim::Object * obj )

inlinestatic

For use in MATLAB and Python to access the concrete class.

Example: cObj = ModelComponent.safeDownCast(obj). This is equivalent to dynamic_cast<ModelComponent*>(obj) in C++.

◆ scale()

void OpenSim::ModelComponent::scale	(	const SimTK::State &	s,
		const ScaleSet &	scaleSet
	)

Scale the ModelComponent.

This method calls the virtual extendScale() method, which may be implemented by any subclass of ModelComponent.

See also: preScale(); extendScale(); postScale()

◆ updateFromXMLNode()

void OpenSim::ModelComponent::updateFromXMLNode	(	SimTK::Xml::Element &	objectElement,
		int	versionNumber
	)

overrideprotectedvirtual

Use this method to deserialize an object from a SimTK::Xml::Element.

The element is assumed to be in the format consistent with the passed-in versionNumber. If there is a file attribute in objectElement it will be ignored; if you want it processed you should call readObjectFromXMLNodeOrFile() instead.

Reimplemented from OpenSim::Object.

◆ updModel()

Model & OpenSim::ModelComponent::updModel ( )

Get a modifiable reference to the Model this component is part of.

Referenced by OpenSim::MocoPhase::updModel(), and OpenSim::MocoProblem::updModel().

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

OpenSim/Simulation/Model/ModelComponent.h

Public Member Functions

Static Public Member Functions

ModelComponent System Creation and Access Methods

Auto-generated functions <br>

Detailed Description

Constructor & Destructor Documentation

◆ ModelComponent() [1/3]

◆ ModelComponent() [2/3]

◆ ModelComponent() [3/3]

◆ ~ModelComponent()

Member Function Documentation

◆ clone()

◆ connectToModel()

◆ extendConnectToModel()

◆ extendFinalizeFromProperties()

◆ extendPostScale()

◆ extendPreScale()

◆ extendScale()

◆ getClassName()

◆ getConcreteClassName()

◆ getModel()

◆ getScaleFactors()

◆ hasModel()

◆ postScale()

◆ preScale()

◆ safeDownCast()

◆ scale()

◆ updateFromXMLNode()

◆ updModel()