A class for reporting the outputs of all model-connected Probes to file during a simulation. More...

Inheritance diagram for OpenSim::ProbeReporter:

Public Member Functions
	ProbeReporter (Model *aModel=0)

	ProbeReporter (const std::string &aFileName)

	ProbeReporter (const ProbeReporter &aObject)

virtual	~ProbeReporter ()

ProbeReporter &	operator= (const ProbeReporter &aActuation)

const Storage &	getProbeStorage () const

Storage &	updProbeStorage ()

void	setModel (Model &aModel) override
	set pointer to model to be analyzed. More...

int	begin (const SimTK::State &s) override

int	step (const SimTK::State &s, int setNumber) override

int	end (const SimTK::State &s) override

void	disableIntegrationOnlyProbes ()

int	printResults (const std::string &aBaseName, const std::string &aDir="", double aDT=-1.0, const std::string &aExtension=".sto") override
	Print the results of the analysis. More...

Public Member Functions inherited from OpenSim::Analysis
	Analysis (Model *aModel=0)
	Default constructor. More...

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

	Analysis (const Analysis &aAnalysis)
	Copy constructor. More...

virtual	~Analysis ()

Analysis &	operator= (const Analysis &aAnalysis)
	Assignment operator. More...

virtual void	setStatesStore (const Storage &aStatesStore)
	set states storage for analysis. More...

void	setOn (bool aTrueFalse)

bool	getOn () const

void	setStartTime (double aStartTime)

double	getStartTime () const

void	setEndTime (double aEndTime)

double	getEndTime () const

void	setInDegrees (bool aTrueFalse)
	Set whether or not to write the output of angles in degrees. More...

bool	getInDegrees () const

virtual bool	proceed (int aStep=0)

void	setStepInterval (int aStepInterval)

int	getStepInterval () const

void	setColumnLabels (const Array< std::string > &aLabels)
	Set the column labels for this analysis. More...

const Array< std::string > &	getColumnLabels () const

void	setStorageInterval (int aInterval)

int	getStorageInterval () const

virtual ArrayPtrs< Storage > &	getStorageList ()

void	setPrintResultFiles (bool aToWrite)

bool	getPrintResultFiles () const

void	assign (Object &aObject) override
	This allows copy assignment in the Java GUI. 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 >
const Property< T > &	getPropertyByName (const std::string &name) 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...

template<class T >
Property< T > &	updPropertyByName (const std::string &name)
	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...

virtual void	updateFromXMLNode (SimTK::Xml::Element &objectElement, int versionNumber)
	Use this method to deserialize an object from a SimTK::Xml::Element. 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

Public Types
typedef ProbeReporter	Self
	This typedef might be useful within the member functions of this class. More...

typedef Analysis	Super
	Use this typedef to refer to the superclass of this class. More...

Public Types inherited from OpenSim::Analysis
typedef Analysis	Self
	This typedef might be useful within the member functions of this class. More...

typedef Object	Super
	Use this typedef to refer to the superclass of this class. More...

Protected Member Functions
virtual int	record (const SimTK::State &s)

Protected Member Functions inherited from OpenSim::Object
	Object ()
	The default constructor is only for use by constructors of derived types. More...

	Object (const std::string &fileName, bool aUpdateFromXMLNode=true)
	Constructor from a file, to be called from other constructors that take a file as input. More...

	Object (const Object &source)
	Copy constructor is invoked automatically by derived classes with default copy constructors; otherwise it must be invoked explicitly. More...

	Object (SimTK::Xml::Element &aElement)
	Construct the base class portion of an Object from a given Xml element that describes this Object. More...

template<class T >
PropertyIndex	addProperty (const std::string &name, const std::string &comment, const T &value)
	Define a new single-value property of known type T, with the given name, associated comment, and initial value. More...

template<class T >
PropertyIndex	addOptionalProperty (const std::string &name, const std::string &comment)
	Add an optional property, meaning it can contain either no value or a single value. More...

template<class T >
PropertyIndex	addOptionalProperty (const std::string &name, const std::string &comment, const T &value)
	Add an optional property, meaning it can contain either no value or a single value. More...

template<class T >
PropertyIndex	addListProperty (const std::string &name, const std::string &comment, int minSize, int maxSize)
	Define a new list-valued property of known type T, with the given name, associated comment, minimum (==0) and maximum (>0) allowable list lengths, and a zero-length initial value. More...

template<class T , template< class > class Container>
PropertyIndex	addListProperty (const std::string &name, const std::string &comment, int minSize, int maxSize, const Container< T > &valueList)
	Define a new list-valued property as above, but assigning an initial value via some templatized container class that supports size() and indexing. More...

PropertyIndex	getPropertyIndex (const std::string &name) const
	Look up a property by name and return its PropertyIndex if it is found. More...

template<class T >
PropertyIndex	getPropertyIndex () const
	Look up an unnamed property by the type of object it contains, and return its PropertyIndex if it is found. More...

template<class T >
void	checkPropertyValueIsPositive (const Property< T > &p) const
	Throw an exception if any of the property's values are not positive. More...

template<class T >
void	checkPropertyValueIsInSet (const Property< T > &p, const std::set< T > &set) const
	Throw an exception if any of the property's values are not in the provided set. More...

template<class T >
void	checkPropertyValueIsInRangeOrSet (const Property< T > &p, const T &lower, const T &upper, const std::set< T > &set) const
	Throw an exception if any of the property's values are neither in the provided range nor in the provided set. More...

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. More...

void	clearObjectIsUpToDateWithProperties ()
	For testing or debugging purposes, manually clear the "object is up to date with respect to properties" flag. More...

void	makeObjectNamesConsistentWithProperties ()
	Make sure the name of an object is consistent with its property type. More...

void	updateFromXMLDocument ()
	Use this method only if you're deserializing from a file and the object is at the top level; that is, primarily in constructors that take a file name as input. More...

void	setDocument (XMLDocument *)
	Unconditionally set the XMLDocument associated with this object. More...

const XMLDocument *	getDocument () const
	Get a const pointer to the document (if any) associated with this object. More...

XMLDocument *	updDocument ()
	Get a writable pointer to the document (if any) associated with this object. More...

Protected Attributes
Storage	_probeStore
	Probe storage. More...

Protected Attributes inherited from OpenSim::Analysis
PropertyInt	_stepIntervalProp
	Step interval. More...

int &	_stepInterval

PropertyBool	_onProp
	On, off flag. More...

bool &	_on

PropertyDbl	_startTimeProp
	Start time for the callback in normalized time. More...

double &	_startTime

PropertyDbl	_endTimeProp
	End time for the callback in normalized time. More...

double &	_endTime

ArrayPtrs< Storage >	_storageList

bool	_printResultFiles

Protected Attributes inherited from OpenSim::Object
PropertySet	_propertySet
	OBSOLETE: Property_Deprecated set for serializable member variables of this and derived classes. More...

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

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

void	assign (Object &aObject) override
	This allows copy assignment in the Java GUI. More...

ProbeReporter *	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
Static Public Member Functions inherited from OpenSim::Analysis
static Analysis *	safeDownCast (OpenSim::Object *obj)
	For use in MATLAB and Python to access the concrete class. More...

static const std::string &	getClassName ()
	This returns "Analysis". 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...

Public Attributes inherited from OpenSim::Analysis
Model *	_model

const Storage *	_statesStore

Static Public Attributes inherited from OpenSim::Object
static const std::string	DEFAULT_NAME
	Name used for default objects when they are serialized. More...

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. More...

#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. More...

#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>. More...

#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. More...

Detailed Description

A class for reporting the outputs of all model-connected Probes to file during a simulation.

This analysis will, at each 'step_interval', cycle through all model Probes and retrieve the SimTK::Vector of probe outputs via getProbeOutputs(s) and store them into a Storage object, which will get recorded to a file at the termination of the simulation. The column labels for each Probe output will come from the overridden method Array<string> getProbeOutputLabels() from the specific Probe subclass. A schematic of the ProbeReporter functionality is shown below (diagram below assumes a single probe, but ProbeReporter will cycle through every Probe in the Model):

                              DEVELOPER NEEDS TO IMPLEMENT
                              THIS INSIDE THE CHILD PROBE
                              ============================
                              |  SimTK::Vector           |
                        |---> |  computeProbeOutputs(s)  | ----|
                        |     ============================     |
===================     |                                      |     ==========================
|  ProbeReporter  | -----                                      ----> |  Output to file        |
|  Analysis       | -----                                      ----> |  at end of simulation  |
===================     |                                      |     ==========================
                        |     ============================     |
                        |---> |  Array<string>           | ----|
                              |  getProbeOutputLabels()  |
                              ============================
                              DEVELOPER NEEDS TO IMPLEMENT
                              THIS INSIDE THE CHILD PROBE

Author: Tim Dorn

Examples:: exampleHangingMuscle.cpp.

Member Typedef Documentation

◆ Self

typedef ProbeReporter OpenSim::ProbeReporter::Self

This typedef might be useful within the member functions of this class.

This is generated by the OpenSim_DECLARE_*_OBJECT macros.

◆ Super

typedef Analysis OpenSim::ProbeReporter::Super

Use this typedef to refer to the superclass of this class.

Avoid using the explicit type name of the superclass; this would introduce bugs if the superclass is changed.

This is generated by the OpenSim_DECLARE_*_OBJECT macros.

Constructor & Destructor Documentation

◆ ProbeReporter() [1/3]

OpenSim::ProbeReporter::ProbeReporter ( Model * aModel = 0 )

◆ ProbeReporter() [2/3]

OpenSim::ProbeReporter::ProbeReporter ( const std::string & aFileName )

◆ ProbeReporter() [3/3]

OpenSim::ProbeReporter::ProbeReporter ( const ProbeReporter & aObject )

◆ ~ProbeReporter()

virtual OpenSim::ProbeReporter::~ProbeReporter ( )

virtual

Member Function Documentation

◆ assign()

void OpenSim::ProbeReporter::assign ( Object & aObject )

inlineoverride

This allows copy assignment in the Java GUI.

Exceptions

Exception if the argument is not of type ProbeReporter.

◆ begin()

int OpenSim::ProbeReporter::begin ( const SimTK::State & s )

overridevirtual

Reimplemented from OpenSim::Analysis.

◆ clone()

ProbeReporter* OpenSim::ProbeReporter::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::Analysis.

◆ disableIntegrationOnlyProbes()

void OpenSim::ProbeReporter::disableIntegrationOnlyProbes ( )

inline

References OpenSim::Object::getName(), OpenSim::Probe::getOperation(), OpenSim::Set< T, C >::getSize(), and OpenSim::Probe::setEnabled().

◆ end()

int OpenSim::ProbeReporter::end ( const SimTK::State & s )

overridevirtual

Reimplemented from OpenSim::Analysis.

◆ getClassName()

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

inlinestatic

This returns "ProbeReporter".

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

This is generated by the OpenSim_DECLARE_*_OBJECT macros.

◆ getConcreteClassName()

const std::string& OpenSim::ProbeReporter::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::Analysis.

◆ getProbeStorage()

const Storage& OpenSim::ProbeReporter::getProbeStorage ( ) const

inline

◆ operator=()

ProbeReporter& OpenSim::ProbeReporter::operator= ( const ProbeReporter & aActuation )

◆ printResults()

int OpenSim::ProbeReporter::printResults	(	const std::string &	aBaseName,
		const std::string &	aDir = `""`,
		double	aDT = `-1.0`,
		const std::string &	aExtension = `".sto"`
	)

overridevirtual

Print the results of the analysis.

Parameters

aBaseName	Base name of file to which to print the data.
aDir	Directory name.
aDT	Time interval between results (linear interpolation is used). If not supplied as an argument or negative, all time steps are printed without interpolation.
aExtension	File extension if not the default ".sto".

Returns: -1 on error, 0 otherwise.

Reimplemented from OpenSim::Analysis.

◆ record()

virtual int OpenSim::ProbeReporter::record ( const SimTK::State & s )

protectedvirtual

◆ safeDownCast()

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

inlinestatic

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

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

◆ setModel()

void OpenSim::ProbeReporter::setModel ( Model & aModel )

overridevirtual

set pointer to model to be analyzed.

Parameters

aModel

Reimplemented from OpenSim::Analysis.

◆ step()

int OpenSim::ProbeReporter::step	(	const SimTK::State &	s,
		int	setNumber
	)

overridevirtual

Reimplemented from OpenSim::Analysis.

◆ updProbeStorage()

Storage& OpenSim::ProbeReporter::updProbeStorage ( )

inline

Member Data Documentation

◆ _probeStore

Storage OpenSim::ProbeReporter::_probeStore

protected

Probe storage.

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

OpenSim/Analyses/ProbeReporter.h

Public Member Functions

Public Types

Protected Member Functions

Protected Attributes

Auto-generated functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Self

◆ Super

Constructor & Destructor Documentation

◆ ProbeReporter() [1/3]

◆ ProbeReporter() [2/3]

◆ ProbeReporter() [3/3]

◆ ~ProbeReporter()

Member Function Documentation

◆ assign()

◆ begin()

◆ clone()

◆ disableIntegrationOnlyProbes()

◆ end()

◆ getClassName()

◆ getConcreteClassName()

◆ getProbeStorage()

◆ operator=()

◆ printResults()

◆ record()

◆ safeDownCast()

◆ setModel()

◆ step()

◆ updProbeStorage()

Member Data Documentation

◆ _probeStore