SystemEnergyProbe is a ModelComponent Probe for computing an operation on a total system energy during a simulation. More...

#include <SystemEnergyProbe.h>

Inheritance diagram for OpenSim::SystemEnergyProbe:

Public Member Functions
	SystemEnergyProbe ()
	Default constructor.
	SystemEnergyProbe (bool computeKE, bool computePE)
	Convenience constructor.
bool	getComputeKineticEnergy () const
	Returns whether kinetic energy is to be included in the system energy computation.
bool	getComputePotentialEnergy () const
	Returns whether potential energy is to be included in the system energy computation.
void	setComputeKineticEnergy (bool c)
	Sets whether kinetic energy is to be included in the system energy computation.
void	setComputePotentialEnergy (bool c)
	Sets whether potential energy is to be included in the system energy computation.
SimTK::Vector	computeProbeInputs (const SimTK::State &state) const override
	Compute the System energy which the Probe operation will be based on.
int	getNumProbeInputs () const override
	Returns the number of probe inputs in the vector returned by computeProbeInputs().
virtual OpenSim::Array < std::string >	getProbeOutputLabels () const override
	Returns the column labels of the probe values for reporting.
Property declarations
These are the serializable properties associated with this class. Others are inherited from the superclass.
	OpenSim_DECLARE_PROPERTY (compute_kinetic_energy, bool,"Specify whether kinetic energy is to be included in the system energy"" computation (true/false).")
	Default is true.
	OpenSim_DECLARE_PROPERTY (compute_potential_energy, bool,"Specify whether potential energy is to be included in the system"" energy computation (true/false).")
	Default is true.
Public Member Functions inherited from OpenSim::Probe
	Probe ()
bool	isDisabled () const
	Returns true if the Probe is disabled or false if the probe is enabled.
void	setDisabled (bool isDisabled)
	Set the Probe as disabled (true) or enabled (false).
std::string	getOperation () const
	Return the operation being performed on the probe value.
void	setOperation (std::string probe_operation)
	Set the operation being performed on the probe value.
SimTK::Vector	getInitialConditions () const
	Return the initial conditions (when the probe_operation is set to 'integrate').
void	setInitialConditions (SimTK::Vector initial_conditions_for_integration)
	Set the initial conditions (when the probe_operation is set to 'integrate').
double	getGain () const
	Return the gain to apply to the probe output.
void	setGain (double gain)
	Set the gain to apply to the probe output.
SimTK::Vector	getProbeOutputs (const SimTK::State &state) const
	Returns the values of the probe after the operation has been performed.
	OpenSim_DECLARE_PROPERTY (isDisabled, bool,"Flag indicating whether the Probe is disabled or not.")
	Enabled by default.
	OpenSim_DECLARE_PROPERTY (probe_operation, std::string,"The operation to perform on the probe input value: ""'value'(no operation, just return the probe value), 'integrate', 'differentiate'")
	OpenSim_DECLARE_PROPERTY (initial_conditions_for_integration, SimTK::Vector,"Vector of initial conditions to be specified if the 'integrate' operation is ""selected. Note that the size of initial conditions must be the same size as ""the data being integrated, otherwise an exception will be thrown.")
	OpenSim_DECLARE_PROPERTY (gain, double,"Constant gain value to scale the probe output by.")
Public Member Functions inherited from OpenSim::ModelComponent
	ModelComponent ()
	Default constructor.
	ModelComponent (const std::string &aFileName, bool aUpdateFromXMLNode=true) SWIG_DECLARE_EXCEPTION
	Construct ModelComponent from an XML file.
	ModelComponent (SimTK::Xml::Element &aNode)
	Construct ModelComponent from a specific node in an XML document.
	ModelComponent (const ModelComponent &source)
	Construct ModelComponent with its contents copied from another ModelComponent; this is a deep copy so nothing is shared with the source after the copy.
virtual	~ModelComponent ()
	Destructor is virtual to allow concrete model component cleanup.
ModelComponent &	operator= (const ModelComponent &aModelComponent)
	Assignment operator to copy contents of an existing component.
const Model &	getModel () const
	Get a const reference to the Model this component is part of.
Model &	updModel ()
	Get a modifiable reference to the Model this component is part of.
virtual void	updateDisplayer (const SimTK::State &s)
	In case the ModelComponent has a visual representation (VisualObject), override this method to update it.
virtual int	getNumStateVariables () const
	Get the number of "Continuous" state variables maintained by the ModelComponent and its specified subcomponents.
virtual Array< std::string >	getStateVariableNames () const
	Get the names of "continuous" state variables maintained by the ModelComponent and its subcomponents.
virtual SimTK::SystemYIndex	getStateVariableSystemIndex (const std::string &stateVariableName) const
	Get the System Index of a state variable allocated by this ModelComponent.
int	getModelingOption (const SimTK::State &state, const std::string &name) const
	Get a ModelingOption flag for this ModelComponent by name.
void	setModelingOption (SimTK::State &state, const std::string &name, int flag) const
	Set the value of a ModelingOption flag for this ModelComponent.
double	getStateVariable (const SimTK::State &state, const std::string &name) const
	Get the value of a state variable allocated by this ModelComponent.
void	setStateVariable (SimTK::State &state, const std::string &name, double value) const
	Set the value of a state variable allocated by this ModelComponent by name.
double	getDiscreteVariable (const SimTK::State &state, const std::string &name) const
	Get the value of a discrete variable allocated by this ModelComponent by name.
void	setDiscreteVariable (SimTK::State &state, const std::string &name, double value) const
	Set the value of a discrete variable allocated by this ModelComponent by name.
template<typename T >
const T &	getCacheVariable (const SimTK::State &state, const std::string &name) const
	Get the value of a cache variable allocated by this ModelComponent by name.
template<typename T >
T &	updCacheVariable (const SimTK::State &state, const std::string &name) const
	Obtain a writable cache variable value allocated by this ModelComponent by name.
void	markCacheVariableValid (const SimTK::State &state, const std::string &name) const
	After updating a cache variable value allocated by this ModelComponent, you can mark its value as valid, which will not change until the realization stage falls below the minimum set at the time the cache variable was created.
void	markCacheVariableInvalid (const SimTK::State &state, const std::string &name) const
	Mark a cache variable value allocated by this ModelComponent as invalid.
bool	isCacheVariableValid (const SimTK::State &state, const std::string &name) const
	Enables the to monitor the validity of the cache variable value using the returned flag.
template<typename T >
void	setCacheVariable (const SimTK::State &state, const std::string &name, T &value) const
	Set cache variable value allocated by this ModelComponent by name.
Public Member Functions inherited from OpenSim::Object
virtual	~Object ()
	Virtual destructor for cleanup.
virtual Object *	clone () const =0
	Create a new heap-allocated copy of the concrete object to which this Object refers.
virtual const std::string &	getConcreteClassName () const =0
	Returns the class name of the concrete %Object-derived class of the actual object referenced by this Object, as a string.
virtual const VisibleObject *	getDisplayer () const
	Methods to support making the object displayable in the GUI or Visualizer Implemented only in few objects.
virtual VisibleObject *	updDisplayer ()
	get Non const pointer to VisibleObject
bool	isEqualTo (const Object &aObject) const
	Equality operator wrapper for use from languages not supporting operator overloading.
Object &	operator= (const Object &aObject)
	Copy assignment copies he base class fields, including the properties.
virtual bool	operator== (const Object &aObject) const
	Determine if two objects are equal.
virtual bool	operator< (const Object &aObject) const
	Provide an ordering for objects so they can be put in sorted containers.
void	setName (const std::string &name)
	Set the name of the Object.
const std::string &	getName () const
	Get the name of this Object.
void	setDescription (const std::string &description)
	Set description, a one-liner summary.
const std::string &	getDescription () const
	Get description, a one-liner summary.
const std::string &	getAuthors () const
	Get Authors of this Object.
void	setAuthors (const std::string &authors)
	Set Authors of this object, call this method in your constructor if needed.
const std::string &	getReferences () const
	Get references or publications to cite if using this object.
void	setReferences (const std::string &references)
	Set references or publications to cite if using this object.
int	getNumProperties () const
	Determine how many properties are stored with this Object.
const AbstractProperty &	getPropertyByIndex (int propertyIndex) const
	Get a const reference to a property by its index number, returned as an AbstractProperty.
AbstractProperty &	updPropertyByIndex (int propertyIndex)
	Get a writable reference to a property by its index number, returned as an AbstractProperty.
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.
const AbstractProperty &	getPropertyByName (const std::string &name) const
	Get a const reference to a property by its name, returned as an AbstractProperty.
AbstractProperty &	updPropertyByName (const std::string &name)
	Get a writable reference to a property by its name, returned as an AbstractProperty.
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.
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.
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.
void	setObjectIsUpToDateWithProperties ()
	When an object is initialized using the current values of its properties, it can set a flag indicating that it is up to date.
bool	isObjectUpToDateWithProperties () const
	Returns \c true if any property's value has changed since the last time setObjectIsUpToDateWithProperties() was called.
void	readObjectFromXMLNodeOrFile (SimTK::Xml::Element &objectElement, int versionNumber)
	We're given an XML element from which we are to populate this Object.
virtual void	updateFromXMLNode (SimTK::Xml::Element &objectElement, int versionNumber)
	Use this method to deserialize an object from a SimTK::Xml::Element.
virtual void	updateXMLNode (SimTK::Xml::Element &parent)
	Serialize this object into the XML node that represents it.
bool	getInlined () const
	Inlined means an in-memory Object that is not associated with an XMLDocument.
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.
std::string	getDocumentFileName () const
	If there is a document associated with this object then return the file name maintained by the document.
void	setAllPropertiesUseDefault (bool aUseDefault)
bool	print (const std::string &fileName)
	Write this %Object into an XML file of the given name; conventionally the suffix to use is ".osim".
std::string	dump (bool dumpName=false)
	dump the XML representation of this Object into an std::string and return it.
void	clearObjectIsUpToDateWithProperties ()
	For testing or debugging purposes, manually clear the "object is up to date with respect to properties" flag.
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.
const std::string &	toString () const
	Wrapper to be used on Java side to display objects in tree; this returns just the object's name.
PropertySet &	getPropertySet ()
	OBSOLETE: Get a reference to the PropertySet maintained by the Object.
const PropertySet &	getPropertySet () const

Additional Inherited Members
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.
static void	renameType (const std::string &oldTypeName, const std::string &newTypeName)
	Support versioning by associating the current %Object type with an old name.
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.
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*.
static Object *	newInstanceOfType (const std::string &concreteClassName)
	Create a new instance of the concrete %Object type whose class name is given as concreteClassName.
static void	getRegisteredTypenames (Array< std::string > &typeNames)
	Retrieve all the typenames registered so far.
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.
static void	PrintPropertyInfo (std::ostream &os, const std::string &classNameDotPropertyName)
	Dump formatted property information to a given output stream, useful for creating a "help" facility for registered objects.
static void	PrintPropertyInfo (std::ostream &os, const std::string &className, const std::string &propertyName)
	Same as the other signature but the class name and property name are provided as two separate strings.
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.
static const std::string &	getClassName ()
	Return the name of this class as a string; i.e., "Object".
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.
static bool	getSerializeAllDefaults ()
	Report the value of the "serialize all defaults" flag.
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.
static void	setDebugLevel (int newLevel)
	Set the debug level to get verbose output.
static int	getDebugLevel ()
	Get current setting of debug level.
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.
static void	RegisterType (const Object &defaultObject)
	OBSOLETE alternate name for registerType().
static void	RenameType (const std::string &oldName, const std::string &newName)
	OBSOLETE alternate name for renameType().
Static Public Attributes inherited from OpenSim::Object
static const std::string	DEFAULT_NAME
	Name used for default objects when they are serialized.
Protected Member Functions inherited from OpenSim::Probe
void	connectToModel (Model &model) override
	Concrete probes may override; be sure to invoke Super::connectToModel() at the beginning of the overriding method.
void	addToSystem (SimTK::MultibodySystem &system) const override
	Concrete probes may override; be sure to invoke Super::addToSystem() at the beginning of the overriding method.
Protected Attributes inherited from OpenSim::ModelComponent
Model *	_model
	The model this component belongs to.
Related Functions inherited from OpenSim::Object
#define	OpenSim_DECLARE_CONCRETE_OBJECT(ConcreteClass, SuperClass)
	Macro to be included as the first line of the class declaration for any non-templatized, concrete class that derives from OpenSim::Object.
#define	OpenSim_DECLARE_ABSTRACT_OBJECT(ConcreteClass, SuperClass)
	Macro to be included as the first line of the class declaration for any still-abstract class that derives from OpenSim::Object.
#define	OpenSim_DECLARE_CONCRETE_OBJECT_T(ConcreteClass, TArg, SuperClass)
	Macro to be included as the first line of the class declaration for any templatized, concrete class that derives from OpenSim::Object, like Set<T>.
#define	OpenSim_DECLARE_ABSTRACT_OBJECT_T(ConcreteClass, TArg, SuperClass)
	Macro to be included as the first line of the class declaration for any templatized, still-abstract class that derives from OpenSim::Object.

Detailed Description

SystemEnergyProbe is a ModelComponent Probe for computing an operation on a total system energy during a simulation.

E.g. Work is the integral of power with respect to time.

Author: Tim Dorn

Constructor & Destructor Documentation

OpenSim::SystemEnergyProbe::SystemEnergyProbe ( )

Default constructor.

OpenSim::SystemEnergyProbe::SystemEnergyProbe	(	bool	computeKE,
		bool	computePE
	)

Convenience constructor.

Member Function Documentation

SimTK::Vector OpenSim::SystemEnergyProbe::computeProbeInputs ( const SimTK::State & state ) const

overridevirtual

Compute the System energy which the Probe operation will be based on.

Implements OpenSim::Probe.

bool OpenSim::SystemEnergyProbe::getComputeKineticEnergy ( ) const

Returns whether kinetic energy is to be included in the system energy

computation.

bool OpenSim::SystemEnergyProbe::getComputePotentialEnergy ( ) const

Returns whether potential energy is to be included in the system energy

computation.

int OpenSim::SystemEnergyProbe::getNumProbeInputs ( ) const

overridevirtual

Returns the number of probe inputs in the vector returned by computeProbeInputs().

Implements OpenSim::Probe.

virtual OpenSim::Array<std::string> OpenSim::SystemEnergyProbe::getProbeOutputLabels ( ) const

overridevirtual

Returns the column labels of the probe values for reporting.

Currently uses the Probe name as the column label, so be sure to name your probe appropiately!

Implements OpenSim::Probe.

OpenSim::SystemEnergyProbe::OpenSim_DECLARE_PROPERTY	(	compute_kinetic_energy	,
		bool	,
		"Specify whether kinetic energy is to be included in the system energy"" computation (true/false)."
	)

Default is true.

OpenSim::SystemEnergyProbe::OpenSim_DECLARE_PROPERTY	(	compute_potential_energy	,
		bool	,
		"Specify whether potential energy is to be included in the system"" energy computation (true/false)."
	)

Default is true.

void OpenSim::SystemEnergyProbe::setComputeKineticEnergy ( bool c )

Sets whether kinetic energy is to be included in the system energy

computation.

void OpenSim::SystemEnergyProbe::setComputePotentialEnergy ( bool c )

Sets whether potential energy is to be included in the system energy

computation.

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

E:/Projects/OpenSim30Br/OpenSim30/OpenSim/Simulation/Model/SystemEnergyProbe.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation