OpenSim::ExternalLoads Class Reference

A convenience class for managing ExternaForce(s) to be applied to a model. More...

Inheritance diagram for OpenSim::ExternalLoads:

Public Member Functions
	ExternalLoads ()
	ExternalLoads (const std::string &fileName, bool aUpdateFromXMLNode)
	Construct an actuator set from file. More...
	ExternalLoads (const ExternalLoads &aExternalLoads)
virtual	~ExternalLoads ()
void	copyData (const ExternalLoads &otherExternalLoads)
void	updateFromXMLNode (SimTK::Xml::Element &aNode, int versionNumber=-1) override
	Override of the default implementation to account for versioning. More...
void	extendConnectToModel (Model &aModel) override
	Perform any necessary initializations required to connect the component into the Model, and check for error conditions. More...
const std::string &	getDataFileName () const
void	setDataFileName (const std::string &aNewFile)
void	transformPointsExpressedInGroundToAppliedBodies (const Storage &kinematics, double startTime=-SimTK::Infinity, double endTime=SimTK::Infinity)
ExternalForce *	transformPointExpressedInGroundToAppliedBody (const ExternalForce &exForce, const Storage &kinematics, double startTime, double endTime)
void	clearLoadedFromFile ()
	ExternalLoads remembers the file it was loaded from, even after being copied. More...
ExternalLoads &	operator= (const ExternalLoads &otherExternalLoads)
Public Member Functions inherited from OpenSim::ModelComponentSet< ExternalForce >
void	extendFinalizeFromProperties () override final
	Perform any time-invariant calculations, data structure initializations, or other configuration based on the component's properties to form a functioning (but not yet connected) component. More...
ModelComponentSet *	clone () 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...
Public Member Functions inherited from OpenSim::Set< ExternalForce, ModelComponent >
virtual	~Set ()
	Destructor. More...
	Set ()
	Default constructor. More...
	Set (const std::string &aFileName, bool aUpdateFromXMLNode=true)
	Construct from file. More...
	Set (const Set< ExternalForce, ModelComponent > &aSet)
	Copy constructor. More...
void	setupGroups ()
	Setup groups (match group member names to set members). More...
Set< ExternalForce, ModelComponent > &	operator= (const Set< ExternalForce, ModelComponent > &set)
	Assign this set to another set. More...
ExternalForce &	operator[] (int aIndex) const
	Get a pointer to the set object at a specified index. More...
void	setMemoryOwner (bool aTrueFalse)
	Set whether or not this Set owns the memory pointed to by the pointers it holds. More...
bool	getMemoryOwner () const
	Get whether or not this array owns the memory pointed to by the pointers in its array. More...
bool	computeNewCapacity (int aMinCapacity, int &rNewCapacity)
	Compute a new capacity that is at least as large as a specified minimum capacity; this method does not change the capacity, it simply computes a new recommended capacity. More...
bool	ensureCapacity (int aCapacity)
	Ensure that the capacity of this array is at least the specified amount. More...
void	trim ()
	Trim the capacity of this array so that it is one larger than the size of this array. More...
int	getCapacity () const
	Get the capacity of this storage instance. More...
void	setCapacityIncrement (int aIncrement)
	Set the amount by which the capacity is increased when the capacity of of the array in exceeded. More...
int	getCapacityIncrement () const
	Get the amount by which the capacity is increased. More...
virtual bool	setSize (int aSize)
	Set the size of the array. More...
int	getSize () const
	Get the size of the array. More...
virtual int	getIndex (const ExternalForce *aObject, int aStartIndex=0) const
	Get the index of an object. More...
virtual int	getIndex (const std::string &aName, int aStartIndex=0) const
	Get the index of an object by specifying its name. More...
void	getGroupNamesContaining (const std::string &aObjectName, Array< std::string > &rGroupNames) const
	Get names of groups containing a given object. More...
virtual bool	adoptAndAppend (ExternalForce *aObject)
	Append to the array, and adopt passed in pointer. More...
virtual bool	cloneAndAppend (const ExternalForce &aObject)
	cloneAndAppend creates a clone of the passed in object and appends the clone to the array. More...
virtual bool	insert (int aIndex, ExternalForce *aObject)
	Insert an object into the array at a specified index. More...
virtual bool	insert (int aIndex, const ExternalForce &aObject)
	Insert an object into the array at a specified index. More...
virtual bool	remove (int aIndex)
	Remove an object from the array at a specified index. More...
virtual bool	remove (const ExternalForce *aObject)
	Remove an object from the array by specifying its address. More...
virtual void	clearAndDestroy ()
virtual bool	set (int aIndex, ExternalForce *aObject, bool preserveGroups=false)
	Set the object at a specified index. More...
virtual bool	set (int aIndex, const ExternalForce &aObject, bool preserveGroups=false)
	Set the object at a specified index. More...
virtual ExternalForce &	get (int aIndex) const
	Get the value at a specified array index. More...
ExternalForce &	get (const std::string &aName)
	Get the first object that has a specified name. More...
const ExternalForce &	get (const std::string &aName) const
bool	contains (const std::string &aName) const
	Get whether this Set contains any object with the specified name. More...
virtual void	getNames (OpenSim::Array< std::string > &rNames) const
	Get names of objects in the set. More...
virtual ExternalForce *	getLast () const
	Get the last value in the array. More...
int	searchBinary (const ExternalForce &aObject, bool aFindFirst=false, int aLo=-1, int aHi=-1) const
	Search for the largest value in the array that is less than or equal to a specified value. More...
int	getNumGroups () const
	Get the number of groups. More...
void	addGroup (const std::string &aGroupName)
	Add an empty group to the set. More...
void	removeGroup (const std::string &aGroupName)
	Remove a group from the set. More...
void	renameGroup (const std::string &oldGroupName, const std::string &newGroupName)
	Rename a group. More...
void	addObjectToGroup (const std::string &aGroupName, const std::string &aObjectName)
	Add an object to a group. More...
void	getGroupNames (Array< std::string > &rGroupNames) const
	Get names of all groups. More...
const ObjectGroup *	getGroup (const std::string &aGroupName) const
	Get a group by name. More...
const ObjectGroup *	getGroup (int aIndex) const
	Get a group by index. More...
Public Member Functions inherited from OpenSim::ModelComponent
	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
	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...
Component &	operator= (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 Component &	getComponent (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)
Component &	updComponent (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 StateVariable *	traverseToStateVariable (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 Object &	getConnectee (const std::string &name) const
	Get the connectee as an Object. More...
const AbstractSocket &	getSocket (const std::string &name) const
	Get an AbstractSocket for the given socket name. More...
AbstractSocket &	updSocket (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 AbstractInput &	getInput (const std::string &name) const
	Get an Input provided by this Component by name. More...
AbstractInput &	updInput (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 AbstractOutput &	getOutput (const std::string &name) const
	Get the Output provided by this Component by name. More...
AbstractOutput &	updOutput (const std::string &name)
	Get a writable reference to an Output provided by this Component by name. More...
SimTK::IteratorRange< OutputConstIterator >	getOutputs () 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 Component &	getOwner () const
	Access the owner of this Component. More...
bool	hasOwner () const
	(For advanced users) Check if this Component has an owner. More...
const Component &	getRoot () 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...
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

Auto-generated functions
static ExternalLoads *	safeDownCast (OpenSim::Object *obj)
	For use in MATLAB and Python to access the concrete class. More...
static const std::string &	getClassName ()
	This returns "ExternalLoads". More...
ExternalLoads *	clone () 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
OpenSim Properties, Sockets, Outputs, Inputs inherited from OpenSim::Component
Component	components
	"List of components that this component owns and serializes." More...
Static Public Member Functions inherited from OpenSim::ModelComponentSet< ExternalForce >
static ModelComponentSet *	safeDownCast (OpenSim::Object *obj)
	For use in MATLAB and Python to access the concrete class. More...
static const std::string &	getClassName ()
	This returns "ModelComponentSet_<T>_". More...
Static Public Member Functions inherited from OpenSim::Set< ExternalForce, ModelComponent >
static Set *	safeDownCast (OpenSim::Object *obj)
	For use in MATLAB and Python to access the concrete class. More...
static const std::string &	getClassName ()
	This returns "Set_<T>_". More...
Static Public Member Functions inherited from OpenSim::ModelComponent
static ModelComponent *	safeDownCast (OpenSim::Object *obj)
	For use in MATLAB and Python to access the concrete class. More...
static const std::string &	getClassName ()
	This returns "ModelComponent". 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...

Detailed Description

A convenience class for managing ExternaForce(s) to be applied to a model.

This includes creating instances and manipulating the data source of individual ExternalForces so that they satisfy conditions imposed by particular Tools. For example, ForwardTool, CMC/RRA, achieve better tracking (slower divergence) if the ground reaction forces are applied to a point that is expressed in the foot frame according to "ideal" kinematics. ExternalLoads provides convenience methods to perform this "mapping" which is beyond the scope of an individual ExternalForce, but is too much detail to have each Tool implement.

An individual ExternalForce has a property for its data source name, but under the management of ExternalLoads, the data source identified by ExternalLoads is used to set the data source on each ExternalForce. If multiple data sources are required for different groups of external forces then use multiple ExternalLoads.

Authors

Ajay Seth, Ayman Habib

Constructor & Destructor Documentation

ExternalLoads() [1/3]

OpenSim::ExternalLoads::ExternalLoads

(

)

ExternalLoads() [2/3]

OpenSim::ExternalLoads::ExternalLoads	(	const std::string &	fileName,
		bool	aUpdateFromXMLNode
	)

Construct an actuator set from file.

Parameters

fileName	Name of the file.
aUpdateFromXMLNode	Should the ExternalLoads be updated from the file?

ExternalLoads() [3/3]

OpenSim::ExternalLoads::ExternalLoads

(

const ExternalLoads &

aExternalLoads

)

~ExternalLoads()

virtual OpenSim::ExternalLoads::~ExternalLoads ( )

virtual

Member Function Documentation

clearLoadedFromFile()

void OpenSim::ExternalLoads::clearLoadedFromFile ( )

inline

ExternalLoads remembers the file it was loaded from, even after being copied.

This file path is used to find the datafile relative to the location of the ExternalLoads file itself. This function can clear the memory of the file that the original ExternalLoads came from. In general, users should not need to use this function.

clone()

ExternalLoads* OpenSim::ExternalLoads::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::ModelComponent.

copyData()

void OpenSim::ExternalLoads::copyData

(

const ExternalLoads &

otherExternalLoads

)

extendConnectToModel()

void OpenSim::ExternalLoads::extendConnectToModel ( Model &  model )

overridevirtual

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 from OpenSim::ModelComponent.

getClassName()

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

inlinestatic

This returns "ExternalLoads".

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

getConcreteClassName()

const std::string& OpenSim::ExternalLoads::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::ModelComponent.

getDataFileName()

const std::string& OpenSim::ExternalLoads::getDataFileName ( ) const

inline

operator=()

ExternalLoads& OpenSim::ExternalLoads::operator=

(

const ExternalLoads &

otherExternalLoads

)

safeDownCast()

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

inlinestatic

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

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

setDataFileName()

void OpenSim::ExternalLoads::setDataFileName ( const std::string &  aNewFile )

inline

transformPointExpressedInGroundToAppliedBody()

ExternalForce* OpenSim::ExternalLoads::transformPointExpressedInGroundToAppliedBody	(	const ExternalForce &	exForce,
		const Storage &	kinematics,
		double	startTime,
		double	endTime
	)

transformPointsExpressedInGroundToAppliedBodies()

void OpenSim::ExternalLoads::transformPointsExpressedInGroundToAppliedBodies	(	const Storage &	kinematics,
		double	startTime = -SimTK::Infinity,
		double	endTime = SimTK::Infinity
	)

updateFromXMLNode()

void OpenSim::ExternalLoads::updateFromXMLNode ( SimTK::Xml::Element &  aNode, int  versionNumber = -1  )

overridevirtual

Override of the default implementation to account for versioning.

Reimplemented from OpenSim::Component.

---

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

• OpenSim/Simulation/Model/ExternalLoads.h