API  4.3
For MATLAB, Python, Java, and C++ users
OpenSim::Bhargava2004SmoothedMuscleMetabolics_MuscleParameters Class Reference

Object class that holds the metabolic parameters required to calculate metabolic power for a single muscle. More...

+ Inheritance diagram for OpenSim::Bhargava2004SmoothedMuscleMetabolics_MuscleParameters:

OpenSim Properties, Sockets, Outputs, Inputs

Properties (single-value)
double specific_tension
 "The specific tension of the muscle (Pascals (N/m^2), default is " "0.25e6)." More...
 
double density
 "The density of the muscle (kg/m^3, default is 1059.7)." More...
 
double ratio_slow_twitch_fibers
 "Ratio of slow twitch fibers in the muscle " "(must be between 0 and 1, default is 0.5)." More...
 
double activation_constant_slow_twitch
 "Activation constant for slow twitch fibers (W/kg, default is 40.0)." More...
 
double activation_constant_fast_twitch
 "Activation constant for fast twitch fibers (W/kg, default is " "133.0)." More...
 
double maintenance_constant_slow_twitch
 "Maintenance constant for slow twitch fibers (W/kg, default is " "74.0)." More...
 
double maintenance_constant_fast_twitch
 "Maintenance constant for fast twitch fibers (W/kg, default is " "111.0)." More...
 
Properties (optional)
bool use_provided_muscle_mass
 "An optional flag that allows the user to explicitly specify a muscle " "mass. If set to true, the 'provided_muscle_mass' property must be " "specified (default is false)." More...
 
double provided_muscle_mass
 "The user specified muscle mass (kg, default is NaN). When this " "property is NaN, the muscle mass is calculated as follows: " "(volume * density) / specific_tension) where " "volume = maximal_isometric_force * optimal_fiber_length." More...
 
Sockets
Muscle muscle
 "The muscle to which the Bhargava2004SmoothedMuscleMetabolics is " "connected." More...
 
- OpenSim Properties, Sockets, Outputs, Inputs inherited from OpenSim::Component
Component components
 "List of components that this component owns and serializes." More...
 

Public Member Functions

 Bhargava2004SmoothedMuscleMetabolics_MuscleParameters ()
 
double getMuscleMass () const
 
void setMuscleMass ()
 
const MusclegetMuscle () const
 
Property-related functions
const double & get_specific_tension () const
 Get the value of the specific_tension property. More...
 
double & upd_specific_tension ()
 Get a writable reference to the specific_tension property. More...
 
void set_specific_tension (const double &value)
 Set the value of the specific_tension property. More...
 
const double & get_density () const
 Get the value of the density property. More...
 
double & upd_density ()
 Get a writable reference to the density property. More...
 
void set_density (const double &value)
 Set the value of the density property. More...
 
const double & get_ratio_slow_twitch_fibers () const
 Get the value of the ratio_slow_twitch_fibers property. More...
 
double & upd_ratio_slow_twitch_fibers ()
 Get a writable reference to the ratio_slow_twitch_fibers property. More...
 
void set_ratio_slow_twitch_fibers (const double &value)
 Set the value of the ratio_slow_twitch_fibers property. More...
 
const bool & get_use_provided_muscle_mass () const
 Get the value of the use_provided_muscle_mass property. More...
 
bool & upd_use_provided_muscle_mass ()
 Get a writable reference to the use_provided_muscle_mass property. More...
 
void set_use_provided_muscle_mass (const bool &value)
 Set the value of the use_provided_muscle_mass property. More...
 
const double & get_provided_muscle_mass () const
 Get the value of the provided_muscle_mass property. More...
 
double & upd_provided_muscle_mass ()
 Get a writable reference to the provided_muscle_mass property. More...
 
void set_provided_muscle_mass (const double &value)
 Set the value of the provided_muscle_mass property. More...
 
const double & get_activation_constant_slow_twitch () const
 Get the value of the activation_constant_slow_twitch property. More...
 
double & upd_activation_constant_slow_twitch ()
 Get a writable reference to the activation_constant_slow_twitch property. More...
 
void set_activation_constant_slow_twitch (const double &value)
 Set the value of the activation_constant_slow_twitch property. More...
 
const double & get_activation_constant_fast_twitch () const
 Get the value of the activation_constant_fast_twitch property. More...
 
double & upd_activation_constant_fast_twitch ()
 Get a writable reference to the activation_constant_fast_twitch property. More...
 
void set_activation_constant_fast_twitch (const double &value)
 Set the value of the activation_constant_fast_twitch property. More...
 
const double & get_maintenance_constant_slow_twitch () const
 Get the value of the maintenance_constant_slow_twitch property. More...
 
double & upd_maintenance_constant_slow_twitch ()
 Get a writable reference to the maintenance_constant_slow_twitch property. More...
 
void set_maintenance_constant_slow_twitch (const double &value)
 Set the value of the maintenance_constant_slow_twitch property. More...
 
const double & get_maintenance_constant_fast_twitch () const
 Get the value of the maintenance_constant_fast_twitch property. More...
 
double & upd_maintenance_constant_fast_twitch ()
 Get a writable reference to the maintenance_constant_fast_twitch property. More...
 
void set_maintenance_constant_fast_twitch (const double &value)
 Set the value of the maintenance_constant_fast_twitch property. More...
 
Socket-related functions
void connectSocket_muscle (const Object &object)
 Connect the 'muscle' Socket to an object of type Muscle. More...
 
- Public Member Functions inherited from OpenSim::Component
 Component ()
 Default constructor. More...
 
 Component (const std::string &aFileName, bool aUpdateFromXMLNode=true)
 Construct Component from an XML file. More...
 
 Component (SimTK::Xml::Element &aNode)
 Construct Component from a specific node in an XML document. More...
 
 Component (const Component &)=default
 Use default copy constructor and assignment operator. More...
 
Componentoperator= (const Component &)=default
 
virtual ~Component ()=default
 Destructor is virtual to allow concrete Component to cleanup. More...
 
virtual void generateDecorations (bool fixed, const ModelDisplayHints &hints, const SimTK::State &state, SimTK::Array_< SimTK::DecorativeGeometry > &appendToThis) const
 Optional method for generating arbitrary display geometry that reflects this Component at the specified state. More...
 
const SimTK::MultibodySystem & getSystem () const
 Get the underlying MultibodySystem that this component is connected to. More...
 
bool hasSystem () const
 Check if this component has an underlying MultibodySystem. More...
 
bool isComponentInOwnershipTree (const Component *component) const
 Does the provided component already exist anywhere in the ownership tree (not just subcomponents of this component)? More...
 
void addComponent (Component *subcomponent)
 
Add a Component (as a subcomponent) of this component. More...
 
template<typename T = Component>
ComponentList< const T > getComponentList () const
 Get an iterator through the underlying subcomponents that this component is composed of. More...
 
template<typename T = Component>
ComponentList< T > updComponentList ()
 Similar to getComponentList(), except the resulting list allows one to modify the components. More...
 
template<typename T = Component>
unsigned countNumComponents () const
 Uses getComponentList<T>() to count the number of underlying subcomponents of the specified type. More...
 
std::string getAbsolutePathString () const
 Get the complete (absolute) pathname for this Component to its ancestral Component, which is the root of the tree to which this Component belongs. More...
 
ComponentPath getAbsolutePath () const
 Return a ComponentPath of the absolute path of this Component. More...
 
std::string getRelativePathString (const Component &wrt) const
 Get the relative path of this Component with respect to another Component, as a string. More...
 
ComponentPath getRelativePath (const Component &wrt) const
 Get the relative path of this Component with respect to another Component. More...
 
bool hasComponent (const std::string &pathname) const
 Query if there is a component (of any type) at the specified path name. More...
 
template<class C = Component>
bool hasComponent (const std::string &pathname) const
 Query if there is a component of a given type at the specified path name. More...
 
template<class C = Component>
const C & getComponent (const std::string &pathname) const
 Get a unique subcomponent of this Component by its path name and type 'C'. More...
 
template<class C = Component>
const C & getComponent (const ComponentPath &pathname) const
 
const ComponentgetComponent (const std::string &pathname) const
 Similar to the templatized getComponent(), except this returns the component as the generic Component type. More...
 
template<class C = Component>
C & updComponent (const std::string &name)
 Get a writable reference to a subcomponent. More...
 
template<class C = Component>
C & updComponent (const ComponentPath &name)
 
ComponentupdComponent (const std::string &pathname)
 Similar to the templatized updComponent(), except this returns the component as the generic Component type. More...
 
unsigned printComponentsMatching (const std::string &substring) const
 Print a list to the console of all components whose absolute path name contains the given string. More...
 
int getNumStateVariables () const
 Get the number of "continuous" state variables maintained by the Component and its subcomponents. More...
 
Array< std::string > getStateVariableNames () const
 Get the names of "continuous" state variables maintained by the Component and its subcomponents. More...
 
template<class C = Component>
const C * findComponent (const ComponentPath &pathToFind) const
 Find a Component to which this Component is an ancestor—in other words, a Component that is directly owned by this Component or is owned by one of its sub-components, sub-sub-components, etc. More...
 
template<class C = Component>
const C * findComponent (const std::string &pathToFind) const
 Same as findComponent(const ComponentPath&), but accepting a string (a path or just a name) as input. More...
 
const StateVariabletraverseToStateVariable (const std::string &pathName) const
 Get a StateVariable anywhere in the Component tree, given a StateVariable path. More...
 
void finalizeFromProperties ()
 Define a Component's internal data members and structure according to its properties. More...
 
void finalizeConnections (Component &root)
 Satisfy the Component's connections specified by its Sockets and Inputs. More...
 
void clearConnections ()
 Disconnect/clear this Component from its aggregate component. More...
 
void addToSystem (SimTK::MultibodySystem &system) const
 Have the Component add itself to the underlying computational System. More...
 
void initStateFromProperties (SimTK::State &state) const
 Initialize Component's state variable values from its properties. More...
 
void setPropertiesFromState (const SimTK::State &state)
 Set Component's properties given a state. More...
 
int getNumSockets () const
 Get the number of Sockets in this Component. More...
 
std::vector< std::string > getSocketNames ()
 Collect and return the names of the sockets in this component. More...
 
template<typename T >
const T & getConnectee (const std::string &name) const
 Get the "connectee" object that the Component's Socket is bound to. More...
 
const ObjectgetConnectee (const std::string &name) const
 Get the connectee as an Object. More...
 
const AbstractSocketgetSocket (const std::string &name) const
 Get an AbstractSocket for the given socket name. More...
 
AbstractSocketupdSocket (const std::string &name)
 Get a writable reference to the AbstractSocket for the given socket name. More...
 
template<typename T >
const Socket< T > & getSocket (const std::string &name) const
 Get a const reference to the concrete Socket provided by this Component by name. More...
 
template<typename T >
Socket< T > & updSocket (const std::string &name)
 Get a writable reference to the concrete Socket provided by this Component by name. More...
 
void printSubcomponentInfo () const
 List all subcomponents by name and recurse into these components to list their subcomponents, and so on. More...
 
void printSocketInfo () const
 List all the Sockets of this component and whether or not they are connected. More...
 
void printInputInfo () const
 List all the inputs of this component and whether or not they are connected. More...
 
template<typename C >
void printSubcomponentInfo () const
 
void printOutputInfo (const bool includeDescendants=true) const
 Print outputs of this component and optionally, those of all subcomponents. More...
 
int getNumInputs () const
 Access the number of Inputs that this component has. More...
 
int getNumOutputs () const
 Access the number of Outputs that this component has. More...
 
std::vector< std::string > getInputNames () const
 Collect and return the names of Inputs in this component as an std::vector. More...
 
std::vector< std::string > getOutputNames () const
 Collect and return the names of Outputs in this component as an std::vector. More...
 
const AbstractInputgetInput (const std::string &name) const
 Get an Input provided by this Component by name. More...
 
AbstractInputupdInput (const std::string &name)
 Get a writable reference to an Input provided by this Component by name. More...
 
template<typename T >
const Input< T > & getInput (const std::string &name) const
 Get a concrete Input that you can directly ask for its values. More...
 
const AbstractOutputgetOutput (const std::string &name) const
 Get the Output provided by this Component by name. More...
 
AbstractOutputupdOutput (const std::string &name)
 Get a writable reference to an Output provided by this Component by name. More...
 
SimTK::IteratorRange< OutputConstIteratorgetOutputs () const
 Iterate through all Outputs of this component. More...
 
int getModelingOption (const SimTK::State &state, const std::string &name) const
 Get a ModelingOption flag for this Component by name. More...
 
void setModelingOption (SimTK::State &state, const std::string &name, int flag) const
 Set the value of a ModelingOption flag for this Component. More...
 
template<typename T >
const T & getInputValue (const SimTK::State &state, const std::string &name) const
 Get the Input value that this component is dependent on. More...
 
template<typename T >
const T & getOutputValue (const SimTK::State &state, const std::string &name) const
 Get the Output value provided by this Component by name. More...
 
double getStateVariableValue (const SimTK::State &state, const std::string &name) const
 Get the value of a state variable allocated by this Component. More...
 
void setStateVariableValue (SimTK::State &state, const std::string &name, double value) const
 Set the value of a state variable allocated by this Component by name. More...
 
SimTK::Vector getStateVariableValues (const SimTK::State &state) const
 Get all values of the state variables allocated by this Component. More...
 
void setStateVariableValues (SimTK::State &state, const SimTK::Vector &values) const
 Set all values of the state variables allocated by this Component. More...
 
double getStateVariableDerivativeValue (const SimTK::State &state, const std::string &name) const
 Get the value of a state variable derivative computed by this Component. More...
 
double getDiscreteVariableValue (const SimTK::State &state, const std::string &name) const
 Get the value of a discrete variable allocated by this Component by name. More...
 
void setDiscreteVariableValue (SimTK::State &state, const std::string &name, double value) const
 Set the value of a discrete variable allocated by this Component by name. More...
 
template<class T >
SimTK::CacheEntryIndex getCacheVariableIndex (const CacheVariable< T > &cv) const
 Get the index of a Component's cache variable in the Subsystem for allocations. More...
 
SimTK::CacheEntryIndex getCacheVariableIndex (const std::string &name) const
 Get the index of a Component's cache variable in the Subsystem for allocations. More...
 
template<class T >
const T & getCacheVariableValue (const SimTK::State &state, const std::string &name) const
 Get the value of a cache variable allocated by this Component by name. More...
 
template<class T >
const T & getCacheVariableValue (const SimTK::State &state, const CacheVariable< T > &cv) const
 Get the value of a cache variable allocated by this Component. More...
 
template<typename T >
void setCacheVariableValue (const SimTK::State &state, const std::string &k, T value) const
 Set the value of a cache variable, identified by name, to a new value and mark the cache variable as valid. More...
 
template<typename T >
void setCacheVariableValue (const SimTK::State &state, const CacheVariable< T > &cv, T value) const
 Set the value of a cache variable to a new value and mark the cache variable as valid. More...
 
template<typename T >
T & updCacheVariableValue (const SimTK::State &state, const std::string &name) const
 Returns a mutable reference to the value of a cache variable identified by name. More...
 
template<typename T >
T & updCacheVariableValue (const SimTK::State &state, const CacheVariable< T > &cv) const
 Returns a mutable reference to the value of a cache variable. More...
 
bool isCacheVariableValid (const SimTK::State &state, const std::string &name) const
 Returns true if the cache variable, identified by name, is valid. More...
 
template<class T >
bool isCacheVariableValid (const SimTK::State &state, const CacheVariable< T > &cv) const
 Returns true if the cache variable is valid. More...
 
void markCacheVariableValid (const SimTK::State &state, const std::string &name) const
 Marks the value of a cache variable, identified by name, as valid. More...
 
template<typename T >
void markCacheVariableValid (const SimTK::State &state, const CacheVariable< T > &cv) const
 Marks the value of a cache variable as valid. More...
 
void markCacheVariableInvalid (const SimTK::State &state, const std::string &name) const
 Marks the value of a cache variable, identified by name, as invalid. More...
 
template<class T >
void markCacheVariableInvalid (const SimTK::State &state, const CacheVariable< T > &cv) const
 Marks the value of a cache variable as invalid. More...
 
const ComponentgetOwner () const
 Access the owner of this Component. More...
 
bool hasOwner () const
 (For advanced users) Check if this Component has an owner. More...
 
const ComponentgetRoot () const
 Obtain the root Component, which is this component if it is orphaned. More...
 
- 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...
 
Objectoperator= (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 AbstractPropertygetPropertyByIndex (int propertyIndex) const
 Get a const reference to a property by its index number, returned as an AbstractProperty. More...
 
AbstractPropertyupdPropertyByIndex (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 AbstractPropertygetPropertyByName (const std::string &name) const
 Get a const reference to a property by its name, returned as an AbstractProperty. More...
 
AbstractPropertyupdPropertyByName (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...
 
PropertySetgetPropertySet ()
 OBSOLETE: Get a reference to the PropertySet maintained by the Object. More...
 
const PropertySetgetPropertySet () const
 

Auto-generated functions

static Bhargava2004SmoothedMuscleMetabolics_MuscleParameterssafeDownCast (OpenSim::Object *obj)
 For use in MATLAB and Python to access the concrete class. More...
 
static const std::string & getClassName ()
 This returns "Bhargava2004SmoothedMuscleMetabolics_MuscleParameters". More...
 
Bhargava2004SmoothedMuscleMetabolics_MuscleParametersclone () const override
 Create a new heap-allocated copy of the concrete object to which this Object refers. More...
 
const std::string & getConcreteClassName () const override
 Returns the class name of the concrete Object-derived class of the actual object referenced by this Object, as a string. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from OpenSim::Component
static ComponentsafeDownCast (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 ObjectgetDefaultInstanceOfType (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 ObjectnewInstanceOfType (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 ObjectmakeObjectFromFile (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 ObjectSafeCopy (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...
 

Detailed Description

Object class that holds the metabolic parameters required to calculate metabolic power for a single muscle.

Constructor & Destructor Documentation

◆ Bhargava2004SmoothedMuscleMetabolics_MuscleParameters()

OpenSim::Bhargava2004SmoothedMuscleMetabolics_MuscleParameters::Bhargava2004SmoothedMuscleMetabolics_MuscleParameters ( )

Member Function Documentation

◆ clone()

Bhargava2004SmoothedMuscleMetabolics_MuscleParameters* OpenSim::Bhargava2004SmoothedMuscleMetabolics_MuscleParameters::clone ( ) const
inlineoverridevirtual

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.

◆ connectSocket_muscle()

void OpenSim::Bhargava2004SmoothedMuscleMetabolics_MuscleParameters::connectSocket_muscle ( const Object object)
inline

Connect the 'muscle' Socket to an object of type Muscle.

Call finalizeConnections() afterwards to update the socket's connectee path property. The reference to the connectee set here takes precedence over the connectee path property.

◆ get_activation_constant_fast_twitch()

const double& OpenSim::Bhargava2004SmoothedMuscleMetabolics_MuscleParameters::get_activation_constant_fast_twitch ( ) const
inline

Get the value of the activation_constant_fast_twitch property.

◆ get_activation_constant_slow_twitch()

const double& OpenSim::Bhargava2004SmoothedMuscleMetabolics_MuscleParameters::get_activation_constant_slow_twitch ( ) const
inline

Get the value of the activation_constant_slow_twitch property.

◆ get_density()

const double& OpenSim::Bhargava2004SmoothedMuscleMetabolics_MuscleParameters::get_density ( ) const
inline

Get the value of the density property.

◆ get_maintenance_constant_fast_twitch()

const double& OpenSim::Bhargava2004SmoothedMuscleMetabolics_MuscleParameters::get_maintenance_constant_fast_twitch ( ) const
inline

Get the value of the maintenance_constant_fast_twitch property.

◆ get_maintenance_constant_slow_twitch()

const double& OpenSim::Bhargava2004SmoothedMuscleMetabolics_MuscleParameters::get_maintenance_constant_slow_twitch ( ) const
inline

Get the value of the maintenance_constant_slow_twitch property.

◆ get_provided_muscle_mass()

const double& OpenSim::Bhargava2004SmoothedMuscleMetabolics_MuscleParameters::get_provided_muscle_mass ( ) const
inline

Get the value of the provided_muscle_mass property.

◆ get_ratio_slow_twitch_fibers()

const double& OpenSim::Bhargava2004SmoothedMuscleMetabolics_MuscleParameters::get_ratio_slow_twitch_fibers ( ) const
inline

Get the value of the ratio_slow_twitch_fibers property.

◆ get_specific_tension()

const double& OpenSim::Bhargava2004SmoothedMuscleMetabolics_MuscleParameters::get_specific_tension ( ) const
inline

Get the value of the specific_tension property.

◆ get_use_provided_muscle_mass()

const bool& OpenSim::Bhargava2004SmoothedMuscleMetabolics_MuscleParameters::get_use_provided_muscle_mass ( ) const
inline

Get the value of the use_provided_muscle_mass property.

◆ getClassName()

static const std::string& OpenSim::Bhargava2004SmoothedMuscleMetabolics_MuscleParameters::getClassName ( )
inlinestatic

This returns "Bhargava2004SmoothedMuscleMetabolics_MuscleParameters".

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

◆ getConcreteClassName()

const std::string& OpenSim::Bhargava2004SmoothedMuscleMetabolics_MuscleParameters::getConcreteClassName ( ) const
inlineoverridevirtual

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.

◆ getMuscle()

const Muscle& OpenSim::Bhargava2004SmoothedMuscleMetabolics_MuscleParameters::getMuscle ( ) const
inline

◆ getMuscleMass()

double OpenSim::Bhargava2004SmoothedMuscleMetabolics_MuscleParameters::getMuscleMass ( ) const
inline

◆ safeDownCast()

static Bhargava2004SmoothedMuscleMetabolics_MuscleParameters* OpenSim::Bhargava2004SmoothedMuscleMetabolics_MuscleParameters::safeDownCast ( OpenSim::Object obj)
inlinestatic

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

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

◆ set_activation_constant_fast_twitch()

void OpenSim::Bhargava2004SmoothedMuscleMetabolics_MuscleParameters::set_activation_constant_fast_twitch ( const double &  value)
inline

Set the value of the activation_constant_fast_twitch property.

◆ set_activation_constant_slow_twitch()

void OpenSim::Bhargava2004SmoothedMuscleMetabolics_MuscleParameters::set_activation_constant_slow_twitch ( const double &  value)
inline

Set the value of the activation_constant_slow_twitch property.

◆ set_density()

void OpenSim::Bhargava2004SmoothedMuscleMetabolics_MuscleParameters::set_density ( const double &  value)
inline

Set the value of the density property.

◆ set_maintenance_constant_fast_twitch()

void OpenSim::Bhargava2004SmoothedMuscleMetabolics_MuscleParameters::set_maintenance_constant_fast_twitch ( const double &  value)
inline

Set the value of the maintenance_constant_fast_twitch property.

◆ set_maintenance_constant_slow_twitch()

void OpenSim::Bhargava2004SmoothedMuscleMetabolics_MuscleParameters::set_maintenance_constant_slow_twitch ( const double &  value)
inline

Set the value of the maintenance_constant_slow_twitch property.

◆ set_provided_muscle_mass()

void OpenSim::Bhargava2004SmoothedMuscleMetabolics_MuscleParameters::set_provided_muscle_mass ( const double &  value)
inline

Set the value of the provided_muscle_mass property.

◆ set_ratio_slow_twitch_fibers()

void OpenSim::Bhargava2004SmoothedMuscleMetabolics_MuscleParameters::set_ratio_slow_twitch_fibers ( const double &  value)
inline

Set the value of the ratio_slow_twitch_fibers property.

◆ set_specific_tension()

void OpenSim::Bhargava2004SmoothedMuscleMetabolics_MuscleParameters::set_specific_tension ( const double &  value)
inline

Set the value of the specific_tension property.

◆ set_use_provided_muscle_mass()

void OpenSim::Bhargava2004SmoothedMuscleMetabolics_MuscleParameters::set_use_provided_muscle_mass ( const bool &  value)
inline

Set the value of the use_provided_muscle_mass property.

◆ setMuscleMass()

void OpenSim::Bhargava2004SmoothedMuscleMetabolics_MuscleParameters::setMuscleMass ( )

◆ upd_activation_constant_fast_twitch()

double& OpenSim::Bhargava2004SmoothedMuscleMetabolics_MuscleParameters::upd_activation_constant_fast_twitch ( )
inline

Get a writable reference to the activation_constant_fast_twitch property.

◆ upd_activation_constant_slow_twitch()

double& OpenSim::Bhargava2004SmoothedMuscleMetabolics_MuscleParameters::upd_activation_constant_slow_twitch ( )
inline

Get a writable reference to the activation_constant_slow_twitch property.

◆ upd_density()

double& OpenSim::Bhargava2004SmoothedMuscleMetabolics_MuscleParameters::upd_density ( )
inline

Get a writable reference to the density property.

◆ upd_maintenance_constant_fast_twitch()

double& OpenSim::Bhargava2004SmoothedMuscleMetabolics_MuscleParameters::upd_maintenance_constant_fast_twitch ( )
inline

Get a writable reference to the maintenance_constant_fast_twitch property.

◆ upd_maintenance_constant_slow_twitch()

double& OpenSim::Bhargava2004SmoothedMuscleMetabolics_MuscleParameters::upd_maintenance_constant_slow_twitch ( )
inline

Get a writable reference to the maintenance_constant_slow_twitch property.

◆ upd_provided_muscle_mass()

double& OpenSim::Bhargava2004SmoothedMuscleMetabolics_MuscleParameters::upd_provided_muscle_mass ( )
inline

Get a writable reference to the provided_muscle_mass property.

◆ upd_ratio_slow_twitch_fibers()

double& OpenSim::Bhargava2004SmoothedMuscleMetabolics_MuscleParameters::upd_ratio_slow_twitch_fibers ( )
inline

Get a writable reference to the ratio_slow_twitch_fibers property.

◆ upd_specific_tension()

double& OpenSim::Bhargava2004SmoothedMuscleMetabolics_MuscleParameters::upd_specific_tension ( )
inline

Get a writable reference to the specific_tension property.

◆ upd_use_provided_muscle_mass()

bool& OpenSim::Bhargava2004SmoothedMuscleMetabolics_MuscleParameters::upd_use_provided_muscle_mass ( )
inline

Get a writable reference to the use_provided_muscle_mass property.

OpenSim Property, Socket, Output, Input Documentation

◆ activation_constant_fast_twitch

double OpenSim::Bhargava2004SmoothedMuscleMetabolics_MuscleParameters::activation_constant_fast_twitch

"Activation constant for fast twitch fibers (W/kg, default is " "133.0)."

This property appears in XML files under the tag <activation_constant_fast_twitch>. This property was generated with the OpenSim_DECLARE_PROPERTY macro; see Property to learn about the property system.

See also
get_activation_constant_fast_twitch(), upd_activation_constant_fast_twitch(), set_activation_constant_fast_twitch()

◆ activation_constant_slow_twitch

double OpenSim::Bhargava2004SmoothedMuscleMetabolics_MuscleParameters::activation_constant_slow_twitch

"Activation constant for slow twitch fibers (W/kg, default is 40.0)."

This property appears in XML files under the tag <activation_constant_slow_twitch>. This property was generated with the OpenSim_DECLARE_PROPERTY macro; see Property to learn about the property system.

See also
get_activation_constant_slow_twitch(), upd_activation_constant_slow_twitch(), set_activation_constant_slow_twitch()

◆ density

double OpenSim::Bhargava2004SmoothedMuscleMetabolics_MuscleParameters::density

"The density of the muscle (kg/m^3, default is 1059.7)."

This property appears in XML files under the tag <density>. This property was generated with the OpenSim_DECLARE_PROPERTY macro; see Property to learn about the property system.

See also
get_density(), upd_density(), set_density()

◆ maintenance_constant_fast_twitch

double OpenSim::Bhargava2004SmoothedMuscleMetabolics_MuscleParameters::maintenance_constant_fast_twitch

"Maintenance constant for fast twitch fibers (W/kg, default is " "111.0)."

This property appears in XML files under the tag <maintenance_constant_fast_twitch>. This property was generated with the OpenSim_DECLARE_PROPERTY macro; see Property to learn about the property system.

See also
get_maintenance_constant_fast_twitch(), upd_maintenance_constant_fast_twitch(), set_maintenance_constant_fast_twitch()

◆ maintenance_constant_slow_twitch

double OpenSim::Bhargava2004SmoothedMuscleMetabolics_MuscleParameters::maintenance_constant_slow_twitch

"Maintenance constant for slow twitch fibers (W/kg, default is " "74.0)."

This property appears in XML files under the tag <maintenance_constant_slow_twitch>. This property was generated with the OpenSim_DECLARE_PROPERTY macro; see Property to learn about the property system.

See also
get_maintenance_constant_slow_twitch(), upd_maintenance_constant_slow_twitch(), set_maintenance_constant_slow_twitch()

◆ muscle

Muscle OpenSim::Bhargava2004SmoothedMuscleMetabolics_MuscleParameters::muscle

"The muscle to which the Bhargava2004SmoothedMuscleMetabolics is " "connected."

In an XML file, you can set this Socket's connectee path via the <socket_muscle > element. This socket was generated with the OpenSim_DECLARE_SOCKET macro; see AbstractSocket for more information.

See also
connectSocket_muscle()

◆ provided_muscle_mass

double OpenSim::Bhargava2004SmoothedMuscleMetabolics_MuscleParameters::provided_muscle_mass

"The user specified muscle mass (kg, default is NaN). When this " "property is NaN, the muscle mass is calculated as follows: " "(volume * density) / specific_tension) where " "volume = maximal_isometric_force * optimal_fiber_length."

This property appears in XML files under the tag <provided_muscle_mass>. This property was generated with the OpenSim_DECLARE_OPTIONAL_PROPERTY macro; see Property to learn about the property system.

See also
get_provided_muscle_mass(), upd_provided_muscle_mass(), set_provided_muscle_mass()

◆ ratio_slow_twitch_fibers

double OpenSim::Bhargava2004SmoothedMuscleMetabolics_MuscleParameters::ratio_slow_twitch_fibers

"Ratio of slow twitch fibers in the muscle " "(must be between 0 and 1, default is 0.5)."

This property appears in XML files under the tag <ratio_slow_twitch_fibers>. This property was generated with the OpenSim_DECLARE_PROPERTY macro; see Property to learn about the property system.

See also
get_ratio_slow_twitch_fibers(), upd_ratio_slow_twitch_fibers(), set_ratio_slow_twitch_fibers()

◆ specific_tension

double OpenSim::Bhargava2004SmoothedMuscleMetabolics_MuscleParameters::specific_tension

"The specific tension of the muscle (Pascals (N/m^2), default is " "0.25e6)."

This property appears in XML files under the tag <specific_tension>. This property was generated with the OpenSim_DECLARE_PROPERTY macro; see Property to learn about the property system.

See also
get_specific_tension(), upd_specific_tension(), set_specific_tension()

◆ use_provided_muscle_mass

bool OpenSim::Bhargava2004SmoothedMuscleMetabolics_MuscleParameters::use_provided_muscle_mass

"An optional flag that allows the user to explicitly specify a muscle " "mass. If set to true, the 'provided_muscle_mass' property must be " "specified (default is false)."

This property appears in XML files under the tag <use_provided_muscle_mass>. This property was generated with the OpenSim_DECLARE_OPTIONAL_PROPERTY macro; see Property to learn about the property system.

See also
get_use_provided_muscle_mass(), upd_use_provided_muscle_mass(), set_use_provided_muscle_mass()

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